<!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>[46780] Options, Meta APIs: Avoid a race condition causing the first of two subsequent requests updating different options at the same time to lose changes.</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 { white-space: pre-line; 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/46780">46780</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/46780","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-11-25 13:44:16 +0000 (Mon, 25 Nov 2019)</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'>Options, Meta APIs: Avoid a race condition causing the first of two subsequent requests updating different options at the same time to lose changes.
Every time an autoloaded option is updated or deleted, the `alloptions` cache is similarly updated. Due to the race condition, on any autoloaded option being updated, every other autoloaded option had its value set to the value at load time, causing a mismatch between the data in the persistent cache and the database.
This change introduces a `$force_cache` parameter for `wp_load_alloptions()` to force an update of the local `alloptions` cache from the persistent cache when an option is added, updated, or deleted, to minimize the chance of affecting other options.
Props fabifott, rmccue, tollmanz, johnjamesjacoby, spacedmonkey, dd32, jipmoors, tellyworth, jeremyclarke, joehoyle, boonebgorges, danielbachhuber, flixos90, jeichorn, mihdan, Grzegorz.Janoszka, SergeyBiryukov.
Merges <a href="https://core.trac.wordpress.org/changeset/46753">[46753]</a> and <a href="https://core.trac.wordpress.org/changeset/46779">[46779]</a> to the 5.3 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/31245">#31245</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches53srcwpincludesoptionphp">branches/5.3/src/wp-includes/option.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches53">branches/5.3/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/5.3
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/5.3 2019-11-25 13:42:22 UTC (rev 46779)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/5.3 2019-11-25 13:44:16 UTC (rev 46780)
</ins><a id="branches53"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/5.3</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/4.9:43557,43622
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:46583,46605-46606,46613,46616,46656,46658,46665,46668,46676-46677,46700-46703,46705,46707,46709,46711,46713,46715,46719-46720,46722,46724,46738,46746-46748,46756-46758,46761-46762,46765,46770,46772
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:46583,46605-46606,46613,46616,46656,46658,46665,46668,46676-46677,46700-46703,46705,46707,46709,46711,46713,46715,46719-46720,46722,46724,46738,46746-46748,46753,46756-46758,46761-46762,46765,46770,46772,46779
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches53srcwpincludesoptionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.3/src/wp-includes/option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.3/src/wp-includes/option.php 2019-11-25 13:42:22 UTC (rev 46779)
+++ branches/5.3/src/wp-includes/option.php 2019-11-25 13:44:16 UTC (rev 46780)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -189,16 +189,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Loads and caches all autoloaded options, if available or all options.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.2.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.3.1 The `$force_cache` parameter was added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $force_cache Optional. Whether to force an update of the local cache
+ * from the persistent cache. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array List of all options.
</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 wp_load_alloptions() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_load_alloptions( $force_cache = false ) {
</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"> if ( ! wp_installing() || ! is_multisite() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $alloptions = wp_cache_get( 'alloptions', 'options' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $alloptions = wp_cache_get( 'alloptions', 'options', $force_cache );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $alloptions = false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -397,7 +400,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! wp_installing() ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $alloptions = wp_load_alloptions();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $alloptions = wp_load_alloptions( true );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $alloptions[ $option ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $alloptions[ $option ] = $serialized_value;
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'alloptions', $alloptions, 'options' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -505,7 +508,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! wp_installing() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'yes' == $autoload ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $alloptions = wp_load_alloptions();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $alloptions = wp_load_alloptions( true );
</ins><span class="cx" style="display: block; padding: 0 10px"> $alloptions[ $option ] = $serialized_value;
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'alloptions', $alloptions, 'options' );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -583,7 +586,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $result = $wpdb->delete( $wpdb->options, array( 'option_name' => $option ) );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! wp_installing() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'yes' == $row->autoload ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $alloptions = wp_load_alloptions();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $alloptions = wp_load_alloptions( true );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $alloptions ) && isset( $alloptions[ $option ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $alloptions[ $option ] );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'alloptions', $alloptions, 'options' );
</span></span></pre>
</div>
</div>
</body>
</html>