Changeset 56595

Timestamp:

09/15/2023 04:13:52 PM (9 days ago)

Author:

spacedmonkey

Message:

Options, Meta APIs: Optimize get_option by relocating notoptions cache lookup.

In the get_option function, a cache lookup for the notoptions key is performed, which stores an array of keys for options known not to exist. This optimization prevents repeated database queries when certain options are requested. However, the cache lookup for notoptions was conducted before checking if the requested option exists in the cache. Given that it's more likely that the option does exist, this commit reorders the checks to first verify the option's existence in the cache before confirming its absence. This adjustment reduces redundant queries and also eliminates an unnecessary cache lookup, improving overall performance.

Props spacedmonkey, costdev, flixos90, azaozz.
Fixes #58277.

Location:

trunk

Files:

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

trunk/src/wp-includes/option.php

@@ -162 +162 @@
 
     if ( ! wp_installing() ) {
-        // 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' );
-        }
-
-        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 );
-        }
-
         $alloptions = wp_load_alloptions();
 
@@ -197 +170 @@
 
             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 ) );
 
@@ -204 +202 @@
                     wp_cache_add( $option, $value, 'options' );
                 } else { // Option does not exist, so we must cache its non-existence.
-                    if ( ! is_array( $notoptions ) ) {
-                        $notoptions = array();
-                    }
-
                     $notoptions[ $option ] = true;
                     wp_cache_set( 'notoptions', $notoptions, 'options' );

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

@@ -102 +102 @@
 
     /**
+     * @ticket 58277
+     *
+     * @covers ::get_option
+     */
+    public function test_get_option_notoptions_cache() {
+        $notoptions = array(
+            'invalid' => true,
+        );
+        wp_cache_set( 'notoptions', $notoptions, 'options' );
+
+        $before = get_num_queries();
+        $value  = get_option( 'invalid' );
+        $after  = get_num_queries();
+
+        $this->assertSame( 0, $after - $before );
+    }
+
+    /**
+     * @ticket 58277
+     *
+     * @covers ::get_option
+     */
+    public function test_get_option_notoptions_set_cache() {
+        get_option( 'invalid' );
+
+        $before = get_num_queries();
+        $value  = get_option( 'invalid' );
+        $after  = get_num_queries();
+
+        $notoptions = wp_cache_get( 'notoptions', 'options' );
+
+        $this->assertSame( 0, $after - $before, 'The notoptions cache was not hit on the second call to `get_option()`.' );
+        $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', '', 'no' );
+        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
      * @covers ::add_option