Changeset 54145

Timestamp:

09/13/2022 07:27:19 PM (2 years ago)

Author:

davidbaumwald

Message:

Options, Meta APIs: Add a new pre-option filter.

Although a pre_option_{$option} filter already exists, this change adds a more general pre_option filter that will run on every get_option call. This brings the control flow into similar flow as update_option.

Props flixos90, NathanAtmoz, desrosj, spacedmonkey, pbearne.
Fixes #37930.

Location:

trunk

Files:

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

trunk/src/wp-includes/option.php

@@ -131 +131 @@
      */
     $pre = apply_filters( "pre_option_{$option}", false, $option, $default );
+
+    /**
+     * Filters the value of all existing options before it is retrieved.
+     *
+     * Returning a truthy value from the filter will effectively short-circuit retrieval
+     * and return the passed value instead.
+     *
+     * @since 6.1.0
+     *
+     * @param mixed  $pre_option  The value to return instead of the option value. This differs
+     *                            from `$default`, which is used as the fallback value in the event
+     *                            the option doesn't exist elsewhere in get_option().
+     *                            Default false (to skip past the short-circuit).
+     * @param string $option      Name of the option.
+     * @param mixed  $default     The fallback value to return if the option does not exist.
+     *                            Default false.
+     */
+    $pre = apply_filters( 'pre_option', $pre, $option, $default );
 
     if ( false !== $pre ) {

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

@@ -298 +298 @@
         );
     }
+
+    /**
+     * @ticket 37930
+     *
+     * @covers ::get_option
+     */
+    public function test_filter_pre_option_all_filter_is_called() {
+        $filter = new MockAction();
+
+        add_filter( 'pre_option', array( $filter, 'filter' ) );
+
+        get_option( 'ignored' );
+
+        $this->assertSame( 1, $filter->get_call_count() );
+    }
 }