<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[21357] trunk/wp-includes/ms-blogs.php: Refactor *_blog_option() functions to use switch_to_blog(), restore_current_blog(), and the *_option() functions.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg > ul, #logmsg > ol { margin-left: 0; margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/21357">21357</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2012-07-27 14:57:32 +0000 (Fri, 27 Jul 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Refactor *_blog_option() functions to use switch_to_blog(), restore_current_blog(), and the *_option() functions. Do not use site-options for blog option caching as this duplicated info and did not properly invalidate.
Props jeremyfelt
fixes <a href="http://core.trac.wordpress.org/ticket/21270">#21270</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesmsblogsphp">trunk/wp-includes/ms-blogs.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesmsblogsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/ms-blogs.php (21356 => 21357)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/ms-blogs.php 2012-07-27 03:56:27 UTC (rev 21356)
+++ trunk/wp-includes/ms-blogs.php 2012-07-27 14:57:32 UTC (rev 21357)
</span><span class="lines">@@ -307,114 +307,95 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieve option value based on setting name and blog_id.
</del><ins>+ * Retrieve option value for a given blog id based on name of option.
</ins><span class="cx"> *
</span><span class="cx"> * If the option does not exist or does not have a value, then the return value
</span><span class="cx"> * will be false. This is useful to check whether you need to install an option
</span><span class="cx"> * and is commonly used during installation of plugin options and to test
</span><span class="cx"> * whether upgrading is required.
</span><span class="cx"> *
</span><del>- * There is a filter called 'blog_option_$option' with the $option being
- * replaced with the option name. The filter takes two parameters. $value and
- * $blog_id. It returns $value.
- * The 'option_$option' filter in get_option() is not called.
</del><ins>+ * If the option was serialized then it will be unserialized when it is returned.
</ins><span class="cx"> *
</span><span class="cx"> * @since MU
</span><del>- * @uses apply_filters() Calls 'blog_option_$optionname' with the option name value.
</del><span class="cx"> *
</span><del>- * @param int $blog_id Optional. Blog ID, can be null to refer to the current blog.
- * @param string $setting Name of option to retrieve. Should already be SQL-escaped.
- * @param string $default (optional) Default value returned if option not found.
</del><ins>+ * @param int $id A blog ID. Can be null to refer to the current blog.
+ * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
+ * @param mixed $default Optional. Default value to return if the option does not exist.
</ins><span class="cx"> * @return mixed Value set for the option.
</span><span class="cx"> */
</span><del>-function get_blog_option( $blog_id, $setting, $default = false ) {
- global $wpdb;
</del><ins>+function get_blog_option( $id, $option, $default = false ) {
+ $id = (int) $id;
</ins><span class="cx">
</span><del>- if ( null === $blog_id )
- $blog_id = $wpdb->blogid;
</del><ins>+ if ( empty( $id ) )
+ $id = get_current_blog_id();
</ins><span class="cx">
</span><del>- $key = $blog_id . '-' . $setting . '-blog_option';
- $value = wp_cache_get( $key, 'site-options' );
- if ( $value == null ) {
- if ( $blog_id == $wpdb->blogid ) {
- $value = get_option( $setting, $default );
- $notoptions = wp_cache_get( 'notoptions', 'options' );
- if ( isset( $notoptions[$setting] ) ) {
- wp_cache_set( $key, 'noop', 'site-options' );
- $value = $default;
- } elseif ( $value == false ) {
- wp_cache_set( $key, 'falsevalue', 'site-options' );
- } else {
- wp_cache_set( $key, $value, 'site-options' );
- }
- return apply_filters( 'blog_option_' . $setting, $value, $blog_id );
- } else {
- $blog_prefix = $wpdb->get_blog_prefix( $blog_id );
- $row = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$blog_prefix}options WHERE option_name = %s", $setting ) );
- if ( is_object( $row ) ) { // Has to be get_row instead of get_var because of funkiness with 0, false, null values
- $value = $row->option_value;
- if ( $value == false )
- wp_cache_set( $key, 'falsevalue', 'site-options' );
- else
- wp_cache_set( $key, $value, 'site-options' );
- } else { // option does not exist, so we must cache its non-existence
- wp_cache_set( $key, 'noop', 'site-options' );
- $value = $default;
- }
- }
- } elseif ( $value == 'noop' ) {
- $value = $default;
- } elseif ( $value == 'falsevalue' ) {
- $value = false;
- }
- // If home is not set use siteurl.
- if ( 'home' == $setting && '' == $value )
- return get_blog_option( $blog_id, 'siteurl' );
</del><ins>+ if ( $id == get_current_blog_id() )
+ return get_option( $option, $default );
</ins><span class="cx">
</span><del>- if ( 'siteurl' == $setting || 'home' == $setting || 'category_base' == $setting )
- $value = untrailingslashit( $value );
</del><ins>+ switch_to_blog( $id );
+ $option = get_option( $option, $default );
+ restore_current_blog();
</ins><span class="cx">
</span><del>- return apply_filters( 'blog_option_' . $setting, maybe_unserialize( $value ), $blog_id );
</del><ins>+ return $option;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Add an option for a particular blog.
</del><ins>+ * Add a new option for a given blog id.
</ins><span class="cx"> *
</span><ins>+ * You do not need to serialize values. If the value needs to be serialized, then
+ * it will be serialized before it is inserted into the database. Remember,
+ * resources can not be serialized or added as an option.
+ *
+ * You can create options without values and then update the values later.
+ * Existing options will not be updated and checks are performed to ensure that you
+ * aren't adding a protected WordPress option. Care should be taken to not name
+ * options the same as the ones which are protected.
+ *
</ins><span class="cx"> * @since MU
</span><span class="cx"> *
</span><del>- * @param int $id The blog id
- * @param string $key The option key
- * @param mixed $value The option value
- * @return bool True on success, false on failure.
</del><ins>+ * @param int $id A blog ID. Can be null to refer to the current blog.
+ * @param string $option Name of option to add. Expected to not be SQL-escaped.
+ * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
+ * @return bool False if option was not added and true if option was added.
</ins><span class="cx"> */
</span><del>-function add_blog_option( $id, $key, $value ) {
</del><ins>+function add_blog_option( $id, $option, $value ) {
</ins><span class="cx"> $id = (int) $id;
</span><span class="cx">
</span><del>- switch_to_blog($id);
- $return = add_option( $key, $value );
</del><ins>+ if ( empty( $id ) )
+ $id = get_current_blog_id();
+
+ if ( $id == get_current_blog_id() )
+ return add_option( $option, $value );
+
+ switch_to_blog( $id );
+ $return = add_option( $option, $value );
</ins><span class="cx"> restore_current_blog();
</span><del>- if ( $return )
- wp_cache_set( $id . '-' . $key . '-blog_option', $value, 'site-options' );
</del><ins>+
</ins><span class="cx"> return $return;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Delete an option for a particular blog.
</del><ins>+ * Removes option by name for a given blog id. Prevents removal of protected WordPress options.
</ins><span class="cx"> *
</span><span class="cx"> * @since MU
</span><span class="cx"> *
</span><del>- * @param int $id The blog id
- * @param string $key The option key
- * @return bool True on success, false on failure.
</del><ins>+ * @param int $id A blog ID. Can be null to refer to the current blog.
+ * @param string $option Name of option to remove. Expected to not be SQL-escaped.
+ * @return bool True, if option is successfully deleted. False on failure.
</ins><span class="cx"> */
</span><del>-function delete_blog_option( $id, $key ) {
</del><ins>+function delete_blog_option( $id, $option ) {
</ins><span class="cx"> $id = (int) $id;
</span><span class="cx">
</span><del>- switch_to_blog($id);
- $return = delete_option( $key );
</del><ins>+ if ( empty( $id ) )
+ $id = get_current_blog_id();
+
+ if ( $id == get_current_blog_id() )
+ return delete_option( $option );
+
+ switch_to_blog( $id );
+ $return = delete_option( $option );
</ins><span class="cx"> restore_current_blog();
</span><del>- if ( $return )
- wp_cache_set( $id . '-' . $key . '-blog_option', '', 'site-options' );
</del><ins>+
</ins><span class="cx"> return $return;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -424,24 +405,25 @@
</span><span class="cx"> * @since MU
</span><span class="cx"> *
</span><span class="cx"> * @param int $id The blog id
</span><del>- * @param string $key The option key
</del><ins>+ * @param string $option The option key
</ins><span class="cx"> * @param mixed $value The option value
</span><span class="cx"> * @return bool True on success, false on failrue.
</span><span class="cx"> */
</span><del>-function update_blog_option( $id, $key, $value, $deprecated = null ) {
</del><ins>+function update_blog_option( $id, $option, $value, $deprecated = null ) {
</ins><span class="cx"> $id = (int) $id;
</span><span class="cx">
</span><span class="cx"> if ( null !== $deprecated )
</span><span class="cx"> _deprecated_argument( __FUNCTION__, '3.1' );
</span><span class="cx">
</span><del>- switch_to_blog($id);
- $return = update_option( $key, $value );
</del><ins>+ if ( $id == get_current_blog_id() )
+ return update_option( $option, $value );
+
+ switch_to_blog( $id );
+ $return = update_option( $option, $value );
</ins><span class="cx"> restore_current_blog();
</span><span class="cx">
</span><span class="cx"> refresh_blog_details( $id );
</span><span class="cx">
</span><del>- if ( $return )
- wp_cache_set( $id . '-' . $key . '-blog_option', $value, 'site-options');
</del><span class="cx"> return $return;
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>