Changeset 59631

Timestamp:

01/15/2025 10:11:15 PM (14 months ago)

Author:

peterwilsoncc

Message:

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 [56595].

Props adamsilverstein, flixos90, ivankristianto, joemcgill, rmccue, siliconforks, spacedmonkey.
Fixes #62692.
See #58277.

Location:

trunk

Files:

• src/wp-includes/option.php (modified) (1 diff)
• tests/phpunit/tests/option/option.php (modified) (4 diffs)

trunk/src/wp-includes/option.php

@@ -163 +163 @@
     if ( ! wp_installing() ) {
         $alloptions = wp_load_alloptions();
-
+        /*
+         * 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.
+         */
         if ( isset( $alloptions[ $option ] ) ) {
             $value = $alloptions[ $option ];
         } else {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
             $value = wp_cache_get( $option, 'options' );
 
             if ( false === $value ) {
-                // Prevent non-existent options from triggering multiple queries.
-                $notoptions = wp_cache_get( 'notoptions', 'options' );
-
-                // 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 );
-                }
 
                 $row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );

trunk/tests/phpunit/tests/option/option.php

@@ -113 +113 @@
 
         $before = get_num_queries();
-        $value  = get_option( 'invalid' );
-        $after  = get_num_queries();
+        get_option( 'invalid' );
+        $after = get_num_queries();
 
         $this->assertSame( 0, $after - $before );
@@ -128 +128 @@
 
         $before = get_num_queries();
-        $value  = get_option( 'invalid' );
-        $after  = get_num_queries();
+        get_option( 'invalid' );
+        $after = get_num_queries();
 
         $notoptions = wp_cache_get( 'notoptions', 'options' );
@@ -136 +136 @@
         $this->assertIsArray( $notoptions, 'The notoptions cache should be set.' );
         $this->assertArrayHasKey( 'invalid', $notoptions, 'The "invalid" option should be in the notoptions cache.' );
-    }
-
-    /**
-     * @ticket 58277
-     *
-     * @covers ::get_option
-     */
-    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.' );
     }
 
@@ -549 +530 @@
         $this->assertArrayNotHasKey( $option_name, $updated_notoptions, 'The "foobar" option should not be in the notoptions cache after adding it.' );
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }