Changeset 55256

Timestamp:

02/07/2023 12:47:30 PM (22 months ago)

Author:

spacedmonkey

Message:

Options, Meta APIs: Add a filter to allow the shortcut return to wp_load_alloptions function.

Add a new filter pre_wp_load_alloptions in the wp_load_alloptions function to short circuit the return value.

Props pbearne, spacedmonkey, joyously, SergeyBiryukov, mukesh27, costdev.
Fixes #56045.

Location:

trunk

Files:

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

trunk/src/wp-includes/option.php

@@ -301 +301 @@
 function wp_load_alloptions( $force_cache = false ) {
     global $wpdb;
+
+    /**
+     * Filters the array of alloptions before it is populated.
+     *
+     * Returning an array from the filter will effectively short circuit
+     * wp_load_alloptions(), returning that value instead.
+     *
+     * @since 6.2.0
+     *
+     * @param array|null $alloptions  An array of alloptions. Default null.
+     * @param bool       $force_cache Whether to force an update of the local cache from the persistent cache. Default false.
+     */
+    $alloptions = apply_filters( 'pre_wp_load_alloptions', null, $force_cache );
+    if ( is_array( $alloptions ) ) {
+        return $alloptions;
+    }
 
     if ( ! wp_installing() || ! is_multisite() ) {

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

@@ -121 +121 @@
         return $this->alloptions;
     }
+
+    /**
+     * Tests that `$alloptions` can be filtered with a custom value, short circuiting `wp_load_alloptions()`.
+     *
+     * @ticket 56045
+     *
+     * @covers ::wp_load_alloptions
+     */
+    public function test_filter_pre_wp_load_alloptions_filter_is_called() {
+        $filter = new MockAction();
+
+        add_filter( 'pre_wp_load_alloptions', array( &$filter, 'filter' ) );
+
+        wp_load_alloptions();
+
+        $this->assertSame(
+            1,
+            $filter->get_call_count(),
+            'The filter was not called 1 time.'
+        );
+
+        $this->assertSame(
+            array( 'pre_wp_load_alloptions' ),
+            $filter->get_hook_names(),
+            'The hook name was incorrect.'
+        );
+    }
 }