<!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>[59631] trunk: Options/Meta APIs: Optimize cache hits for non-existent 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/59631">59631</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/59631","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>2025-01-15 22:11:15 +0000 (Wed, 15 Jan 2025)</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: Optimize cache hits for non-existent options.
Optimize the order of checking the various options caches in `get_option()` to prevent hitting external caches each time it is called for a known non-existent option.
The caches are checked in the following order when getting an option:
1. Check the `alloptions` cache first to prioritize existing loaded options.
2. Check the `notoptions` cache before a cache lookup or DB hit.
3. Check the `options` cache prior to a DB hit.
Follow up to <a href="https://core.trac.wordpress.org/changeset/56595">[56595]</a>.
Props adamsilverstein, flixos90, ivankristianto, joemcgill, rmccue, siliconforks, spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/62692">#62692</a>.
See <a href="https://core.trac.wordpress.org/ticket/58277">#58277</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 2025-01-15 18:34:35 UTC (rev 59630)
+++ trunk/src/wp-includes/option.php 2025-01-15 22:11:15 UTC (rev 59631)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -162,38 +162,47 @@
</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"> $alloptions = wp_load_alloptions();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * When getting an option value, we check in the following order for performance:
+ *
+ * 1. Check the 'alloptions' cache first to prioritize existing loaded options.
+ * 2. Check the 'notoptions' cache before a cache lookup or DB hit.
+ * 3. Check the 'options' cache prior to a DB hit.
+ * 4. Check the DB for the option and cache it in either the 'options' or 'notoptions' cache.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $alloptions[ $option ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = $alloptions[ $option ];
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check for non-existent options first to avoid unnecessary object cache lookups and DB hits.
+ $notoptions = wp_cache_get( 'notoptions', 'options' );
+
+ if ( ! is_array( $notoptions ) ) {
+ $notoptions = array();
+ wp_cache_set( 'notoptions', $notoptions, 'options' );
+ }
+
+ if ( isset( $notoptions[ $option ] ) ) {
+ /**
+ * Filters the default value for an option.
+ *
+ * The dynamic portion of the hook name, `$option`, refers to the option name.
+ *
+ * @since 3.4.0
+ * @since 4.4.0 The `$option` parameter was added.
+ * @since 4.7.0 The `$passed_default` parameter was added to distinguish between a `false` value and the default parameter value.
+ *
+ * @param mixed $default_value The default value to return if the option does not exist
+ * in the database.
+ * @param string $option Option name.
+ * @param bool $passed_default Was `get_option()` passed a default value?
+ */
+ return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $value = wp_cache_get( $option, 'options' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $value ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Prevent non-existent options from triggering multiple queries.
- $notoptions = wp_cache_get( 'notoptions', 'options' );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Prevent non-existent `notoptions` key from triggering multiple key lookups.
- if ( ! is_array( $notoptions ) ) {
- $notoptions = array();
- wp_cache_set( 'notoptions', $notoptions, 'options' );
- } elseif ( isset( $notoptions[ $option ] ) ) {
- /**
- * Filters the default value for an option.
- *
- * The dynamic portion of the hook name, `$option`, refers to the option name.
- *
- * @since 3.4.0
- * @since 4.4.0 The `$option` parameter was added.
- * @since 4.7.0 The `$passed_default` parameter was added to distinguish between a `false` value and the default parameter value.
- *
- * @param mixed $default_value The default value to return if the option does not exist
- * in the database.
- * @param string $option Option name.
- * @param bool $passed_default Was `get_option()` passed a default value?
- */
- return apply_filters( "default_option_{$option}", $default_value, $option, $passed_default );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Has to be get_row() instead of get_var() because of funkiness with 0, false, null values.
</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 2025-01-15 18:34:35 UTC (rev 59630)
+++ trunk/tests/phpunit/tests/option/option.php 2025-01-15 22:11:15 UTC (rev 59631)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -112,8 +112,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_cache_set( 'notoptions', $notoptions, 'options' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $before = get_num_queries();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $value = get_option( 'invalid' );
- $after = get_num_queries();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ get_option( 'invalid' );
+ $after = get_num_queries();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 0, $after - $before );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,8 +127,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> get_option( 'invalid' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $before = get_num_queries();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $value = get_option( 'invalid' );
- $after = get_num_queries();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ get_option( 'invalid' );
+ $after = get_num_queries();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $notoptions = wp_cache_get( 'notoptions', 'options' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -138,26 +138,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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @ticket 58277
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @covers ::get_option
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- */
- public function test_get_option_notoptions_do_not_load_cache() {
- add_option( 'foo', 'bar', '', false );
- wp_cache_delete( 'notoptions', 'options' );
-
- $before = get_num_queries();
- $value = get_option( 'foo' );
- $after = get_num_queries();
-
- $notoptions = wp_cache_get( 'notoptions', 'options' );
-
- $this->assertSame( 0, $after - $before, 'The options cache was not hit on the second call to `get_option()`.' );
- $this->assertFalse( $notoptions, 'The notoptions cache should not be set.' );
- }
-
- /**
- * @covers ::get_option
</del><span class="cx" style="display: block; padding: 0 10px"> * @covers ::add_option
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::delete_option
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::update_option
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -548,4 +529,88 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $updated_notoptions = wp_cache_get( 'notoptions', 'options' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( $option_name, $updated_notoptions, 'The "foobar" option should not be in the notoptions cache after adding it.' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Test that get_option() does not hit the external cache multiple times for the same option.
+ *
+ * @ticket 62692
+ *
+ * @covers ::get_option
+ *
+ * @dataProvider data_get_option_does_not_hit_the_external_cache_multiple_times_for_the_same_option
+ *
+ * @param int $expected_connections Expected number of connections to the memcached server.
+ * @param bool $option_exists Whether the option should be set. Default true.
+ * @param string $autoload Whether the option should be auto loaded. Default true.
+ */
+ public function test_get_option_does_not_hit_the_external_cache_multiple_times_for_the_same_option( $expected_connections, $option_exists = true, $autoload = true ) {
+ if ( ! wp_using_ext_object_cache() ) {
+ $this->markTestSkipped( 'This test requires an external object cache.' );
+ }
+
+ if ( false === $this->helper_object_cache_stats_cmd_get() ) {
+ $this->markTestSkipped( 'This test requires access to the number of get requests to the external object cache.' );
+ }
+
+ if ( $option_exists ) {
+ add_option( 'ticket-62692', 'value', '', $autoload );
+ }
+
+ wp_cache_delete_multiple( array( 'ticket-62692', 'notoptions', 'alloptions' ), 'options' );
+
+ $connections_start = $this->helper_object_cache_stats_cmd_get();
+
+ $call_getter = 10;
+ while ( $call_getter-- ) {
+ get_option( 'ticket-62692' );
+ }
+
+ $connections_end = $this->helper_object_cache_stats_cmd_get();
+
+ $this->assertSame( $expected_connections, $connections_end - $connections_start );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_get_option_does_not_hit_the_external_cache_multiple_times_for_the_same_option() {
+ return array(
+ 'exists, autoload' => array( 1, true, true ),
+ 'exists, not autoloaded' => array( 3, true, false ),
+ 'does not exist' => array( 3, false ),
+ );
+ }
+
+ /**
+ * Helper function to get the number of get commands from the external object cache.
+ *
+ * @return int|false Number of get command calls, false if unavailable.
+ */
+ public function helper_object_cache_stats_cmd_get() {
+ if ( ! wp_using_ext_object_cache() || ! function_exists( 'wp_cache_get_stats' ) ) {
+ return false;
+ }
+
+ $stats = wp_cache_get_stats();
+
+ // Check the shape of the stats.
+ if ( ! is_array( $stats ) ) {
+ return false;
+ }
+
+ // Get the first server's stats.
+ $stats = array_shift( $stats );
+
+ if ( ! is_array( $stats ) ) {
+ return false;
+ }
+
+ if ( ! array_key_exists( 'cmd_get', $stats ) ) {
+ return false;
+ }
+
+ return $stats['cmd_get'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>