Changeset 60959 for trunk/src/wp-includes/option.php

Timestamp:

10/17/2025 06:46:42 PM (9 months ago)

Author:

johnjamesjacoby

Message:

Networks and Sites: add a general pre_site_option filter to get_network_option().

This change brings get_network_option() up-to-speed with get_option() by adding a more generalized way to short-circuit its return value.

It also introduces 2 new unit tests: one to mirror an existing pre_option test, and another to confirm that this new filter is working as intended.

Props audrasjb, Drivingralle, johnjamesjacoby, jorbin, nimeshatxecurify, rollybueno, shailu25, welcher, westonruter.

See #37930, r54145.

Fixes #56870.

File:

• trunk/src/wp-includes/option.php (modified) (2 diffs)

trunk/src/wp-includes/option.php

@@ -135 +135 @@
          * 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.
+         * Returning a value other than false from the filter will short-circuit retrieval
+         * and return that value instead.
          *
          * @since 6.1.0
@@ -2038 +2038 @@
         $pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default_value );
 
+        /**
+         * Filters the value of an existing network options before it is retrieved.
+         *
+         * Returning a value other than false from the filter will short-circuit retrieval
+         * and return that value instead.
+         *
+         * @since 6.9.0
+         *
+         * @param mixed  $pre             The value to return instead of the network option value. This differs
+         *                                from `$default`, which is used as the fallback value in the event
+         *                                the option doesn't exist elsewhere in get_network_option().
+         *                                Default false (to skip past the short-circuit).
+         * @param string $option          Name of the option.
+         * @param int    $network_id      ID of the network.
+         * @param mixed  $default_value   The fallback value to return if the option does not exist.
+         *                                Default false.
+         */
+        $pre = apply_filters( 'pre_site_option', $pre, $option, $network_id, $default_value );
+
         if ( false !== $pre ) {
                 return $pre;