<!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>[58782] trunk: Options, Meta APIs: Prime `notoptions` cache when deleting options.</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/58782">58782</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/58782","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-07-23 00:25:19 +0000 (Tue, 23 Jul 2024)</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: Prime `notoptions` cache when deleting options.
Prime the `notoptions` cache within `delete_option` and `delete_network_option` to avoid the need for a database query if `get_option` or `get_network_option` is subsequently called.
Adds some associated tests to ensure that an option is cleared from the notoptions cache when an option is added either via `add_option`, `update_option` or their network option equivalent.
Props pbearne, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/61484">#61484</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesoptionphp">trunk/src/wp-includes/option.php</a></li>
<li><a href="#trunktestsphpunittestsoptionnetworkOptionphp">trunk/tests/phpunit/tests/option/networkOption.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 2024-07-22 23:19:20 UTC (rev 58781)
+++ trunk/src/wp-includes/option.php 2024-07-23 00:25:19 UTC (rev 58782)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1217,6 +1217,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_delete( $option, 'options' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $notoptions = wp_cache_get( 'notoptions', 'options' );
+
+ if ( ! is_array( $notoptions ) ) {
+ $notoptions = array();
+ }
+ $notoptions[ $option ] = true;
+
+ wp_cache_set( 'notoptions', $notoptions, 'options' );
</ins><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 ( $result ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2284,6 +2293,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'delete_site_option', $option, $network_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $notoptions_key = "$network_id:notoptions";
+ $notoptions = wp_cache_get( $notoptions_key, 'site-options' );
+
+ if ( ! is_array( $notoptions ) ) {
+ $notoptions = array();
+ }
+ $notoptions[ $option ] = true;
+ wp_cache_set( $notoptions_key, $notoptions, 'site-options' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsoptionnetworkOptionphp"></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/networkOption.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/option/networkOption.php 2024-07-22 23:19:20 UTC (rev 58781)
+++ trunk/tests/phpunit/tests/option/networkOption.php 2024-07-23 00:25:19 UTC (rev 58782)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -57,6 +57,30 @@
</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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Tests that calling delete_network_option() updates nooptions when option deleted.
+ *
+ * @ticket 61484
+ *
+ * @covers ::delete_network_option
+ */
+ public function test_check_delete_network_option_updates_notoptions() {
+ add_network_option( 1, 'foo', 'value1' );
+
+ delete_network_option( 1, 'foo' );
+ $cache_key = is_multisite() ? '1:notoptions' : 'notoptions';
+ $cache_group = is_multisite() ? 'site-options' : 'options';
+ $notoptions = wp_cache_get( $cache_key, $cache_group );
+ $this->assertIsArray( $notoptions, 'The notoptions cache is expected to be an array.' );
+ $this->assertTrue( $notoptions['foo'], 'The deleted options is expected to be in notoptions.' );
+
+ $before = get_num_queries();
+ get_network_option( 1, 'foo' );
+ $queries = get_num_queries() - $before;
+
+ $this->assertSame( 0, $queries, 'get_network_option should not make any database queries.' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 22846
</span><span class="cx" style="display: block; padding: 0 10px"> * @group ms-excluded
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -228,4 +252,54 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Check that no new database queries were performed.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $num_queries_pre_update, get_num_queries() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests that calling update_network_option() clears the notoptions cache.
+ *
+ * @ticket 61484
+ *
+ * @covers ::update_network_option
+ */
+ public function test_update_network_option_clears_the_notoptions_cache() {
+ $option_name = 'ticket_61484_option_to_be_created';
+ $cache_key = is_multisite() ? '1:notoptions' : 'notoptions';
+ $cache_group = is_multisite() ? 'site-options' : 'options';
+ $notoptions = wp_cache_get( $cache_key, $cache_group );
+ if ( ! is_array( $notoptions ) ) {
+ $notoptions = array();
+ }
+ $notoptions[ $option_name ] = true;
+ wp_cache_set( $cache_key, $notoptions, $cache_group );
+ $this->assertArrayHasKey( $option_name, wp_cache_get( $cache_key, $cache_group ), 'The "foobar" option should be in the notoptions cache.' );
+
+ update_network_option( 1, $option_name, 'baz' );
+
+ $updated_notoptions = wp_cache_get( $cache_key, $cache_group );
+ $this->assertArrayNotHasKey( $option_name, $updated_notoptions, 'The "foobar" option should not be in the notoptions cache after updating it.' );
+ }
+
+ /**
+ * Tests that calling add_network_option() clears the notoptions cache.
+ *
+ * @ticket 61484
+ *
+ * @covers ::add_network_option
+ */
+ public function test_add_network_option_clears_the_notoptions_cache() {
+ $option_name = 'ticket_61484_option_to_be_created';
+ $cache_key = is_multisite() ? '1:notoptions' : 'notoptions';
+ $cache_group = is_multisite() ? 'site-options' : 'options';
+ $notoptions = wp_cache_get( $cache_key, $cache_group );
+ if ( ! is_array( $notoptions ) ) {
+ $notoptions = array();
+ }
+ $notoptions[ $option_name ] = true;
+ wp_cache_set( $cache_key, $notoptions, $cache_group );
+ $this->assertArrayHasKey( $option_name, wp_cache_get( $cache_key, $cache_group ), 'The "foobar" option should be in the notoptions cache.' );
+
+ add_network_option( 1, $option_name, 'baz' );
+
+ $updated_notoptions = wp_cache_get( $cache_key, $cache_group );
+ $this->assertArrayNotHasKey( $option_name, $updated_notoptions, 'The "foobar" option should not be in the notoptions cache after updating it.' );
+ }
</ins><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 2024-07-22 23:19:20 UTC (rev 58781)
+++ trunk/tests/phpunit/tests/option/option.php 2024-07-23 00:25:19 UTC (rev 58782)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -478,4 +478,72 @@
</span><span class="cx" style="display: block; padding: 0 10px"> delete_option( 'foo' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( get_option( 'foo' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests that calling delete_option() updates notoptions when option deleted.
+ *
+ * @ticket 61484
+ *
+ * @covers ::delete_option
+ */
+ public function test_check_delete_option_updates_notoptions() {
+ add_option( 'foo', 'value1' );
+
+ delete_option( 'foo' );
+ $notoptions = wp_cache_get( 'notoptions', 'options' );
+ $this->assertIsArray( $notoptions, 'The notoptions cache is expected to be an array.' );
+ $this->assertTrue( $notoptions['foo'], 'The deleted options is expected to be in notoptions.' );
+
+ $before = get_num_queries();
+ get_option( 'foo' );
+ $queries = get_num_queries() - $before;
+
+ $this->assertSame( 0, $queries, 'get_option should not make any database queries.' );
+ }
+
+ /**
+ * Tests that calling update_option() clears the notoptions cache.
+ *
+ * @ticket 61484
+ *
+ * @covers ::update_option
+ */
+ public function test_update_option_clears_the_notoptions_cache() {
+ $option_name = 'ticket_61484_option_to_be_created';
+ $notoptions = wp_cache_get( 'notoptions', 'options' );
+ if ( ! is_array( $notoptions ) ) {
+ $notoptions = array();
+ }
+ $notoptions[ $option_name ] = true;
+ wp_cache_set( 'notoptions', $notoptions, 'options' );
+ $this->assertArrayHasKey( $option_name, wp_cache_get( 'notoptions', 'options' ), 'The "foobar" option should be in the notoptions cache.' );
+
+ update_option( $option_name, 'baz' );
+
+ $updated_notoptions = wp_cache_get( 'notoptions', 'options' );
+ $this->assertArrayNotHasKey( $option_name, $updated_notoptions, 'The "foobar" option should not be in the notoptions cache after updating it.' );
+ }
+
+ /**
+ * Tests that calling add_option() clears the notoptions cache.
+ *
+ * @ticket 61484
+ *
+ * @covers ::add_option
+ */
+ public function test_add_option_clears_the_notoptions_cache() {
+ $option_name = 'ticket_61484_option_to_be_created';
+ $notoptions = wp_cache_get( 'notoptions', 'options' );
+ if ( ! is_array( $notoptions ) ) {
+ $notoptions = array();
+ }
+ $notoptions[ $option_name ] = true;
+ wp_cache_set( 'notoptions', $notoptions, 'options' );
+ $this->assertArrayHasKey( $option_name, wp_cache_get( 'notoptions', 'options' ), 'The "foobar" option should be in the notoptions cache.' );
+
+ add_option( $option_name, 'baz' );
+
+ $updated_notoptions = wp_cache_get( 'notoptions', 'options' );
+ $this->assertArrayNotHasKey( $option_name, $updated_notoptions, 'The "foobar" option should not be in the notoptions cache after adding it.' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>