<!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>[31628] trunk: Introduce `$autoload` parameter to `update_option()`.</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 { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/31628">31628</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/31628","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-03-05 19:13:00 +0000 (Thu, 05 Mar 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Introduce `$autoload` parameter to `update_option()`.
When creating an option via `add_option()`, the `$autoload` param allows you to
tell WP whether the option should be loaded as part of the 'alloptions' cache
during every pageload. `update_option()`, when used with a non-existent option
calls `add_option()` internally. The new `$autoload` param in `update_option()`
is passed along to `add_option()` in cases where the option does not yet exist.
The associated unit tests are skipped on multisite due to an issue that causes
`WP_INSTALLING` to force cache misses. See <a href="https://core.trac.wordpress.org/ticket/31130">#31130</a>.
Props codix, nofearinc, MikeHansenMe.
Fixes <a href="https://core.trac.wordpress.org/ticket/26394">#26394</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesoptionphp">trunk/src/wp-includes/option.php</a></li>
<li><a href="#trunktestsphpunittestsoptionoptionphp">trunk/tests/phpunit/tests/option/option.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesoptionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/option.php 2015-03-05 16:53:27 UTC (rev 31627)
+++ trunk/src/wp-includes/option.php 2015-03-05 19:13:00 UTC (rev 31628)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -221,12 +221,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * to set whether an option is autoloaded, then you need to use the add_option().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.0.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.2.0 The `$autoload` parameter was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $option Option name. Expected to not be SQL-escaped.
- * @param mixed $value Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $option Option name. Expected to not be SQL-escaped.
+ * @param mixed $value Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
+ * @param string|bool $autoload Optional. Whether to load the option when WordPress starts up. Accepts 'yes' or true to
+ * enable, 'no' or false to disable. Default is enabled.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool False if value was not updated and true if value was updated.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function update_option( $option, $value ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function update_option( $option, $value, $autoload = 'yes' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $option = trim($option);
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -269,8 +272,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/option.php */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( apply_filters( 'default_option_' . $option, false ) === $old_value )
- return add_option( $option, $value );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( apply_filters( 'default_option_' . $option, false ) === $old_value ) {
+ return add_option( $option, $value, '', $autoload );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $serialized_value = maybe_serialize( $value );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsoptionoptionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/option/option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/option/option.php 2015-03-05 16:53:27 UTC (rev 31627)
+++ trunk/tests/phpunit/tests/option/option.php 2015-03-05 19:13:00 UTC (rev 31628)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -149,4 +149,102 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $actual = $wpdb->get_row( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s LIMIT 1", $name ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $expected, $actual->autoload );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 26394
+ */
+ public function test_update_option_should_set_autoload_yes_for_nonexistent_option_when_autoload_param_is_missing() {
+ if ( is_multisite() ) {
+ $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
+ }
+
+ global $wpdb;
+ wp_cache_flush();
+ update_option( 'test_update_option_default', 'value' );
+ wp_cache_flush();
+
+ // Populate the alloptions cache, which includes autoload=yes options.
+ wp_load_alloptions();
+
+ $before = $wpdb->num_queries;
+ $value = get_option( 'test_update_option_default' );
+ $after = $wpdb->num_queries;
+
+ $this->assertEquals( $before, $after );
+ $this->assertEquals( $value, 'value' );
+ }
+
+ /**
+ * @ticket 26394
+ */
+ public function test_update_option_should_set_autoload_yes_for_nonexistent_option_when_autoload_param_is_yes() {
+ if ( is_multisite() ) {
+ $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
+ }
+
+ global $wpdb;
+ wp_cache_flush();
+ update_option( 'test_update_option_default', 'value', 'yes' );
+ wp_cache_flush();
+
+ // Populate the alloptions cache, which includes autoload=yes options.
+ wp_load_alloptions();
+
+ $before = $wpdb->num_queries;
+ $value = get_option( 'test_update_option_default' );
+ $after = $wpdb->num_queries;
+
+ $this->assertEquals( $before, $after );
+ $this->assertEquals( $value, 'value' );
+ }
+
+ /**
+ * @ticket 26394
+ */
+ public function test_update_option_should_set_autoload_yes_for_nonexistent_option_when_autoload_param_is_no() {
+ if ( is_multisite() ) {
+ $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
+ }
+
+ global $wpdb;
+ wp_cache_flush();
+ update_option( 'test_update_option_default', 'value', 'no' );
+ wp_cache_flush();
+
+ // Populate the alloptions cache, which does not include autoload=no options.
+ wp_load_alloptions();
+
+ $before = $wpdb->num_queries;
+ $value = get_option( 'test_update_option_default' );
+ $after = $wpdb->num_queries;
+
+ // Database has been hit.
+ $this->assertEquals( $before + 1, $after );
+ $this->assertEquals( $value, 'value' );
+ }
+
+ /**
+ * @ticket 26394
+ */
+ public function test_update_option_should_set_autoload_yes_for_nonexistent_option_when_autoload_param_is_false() {
+ if ( is_multisite() ) {
+ $this->markTestSkipped( 'Not testable in MS: wpmu_create_blog() defines WP_INSTALLING, which causes cache misses.' );
+ }
+
+ global $wpdb;
+ wp_cache_flush();
+ update_option( 'test_update_option_default', 'value', false );
+ wp_cache_flush();
+
+ // Populate the alloptions cache, which does not include autoload=no options.
+ wp_load_alloptions();
+
+ $before = $wpdb->num_queries;
+ $value = get_option( 'test_update_option_default' );
+ $after = $wpdb->num_queries;
+
+ // Database has been hit.
+ $this->assertEquals( $before + 1, $after );
+ $this->assertEquals( $value, 'value' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>