Changeset 60978

Timestamp:

10/19/2025 07:45:22 PM (4 weeks ago)

Author:

SergeyBiryukov

Message:

Docs: Correct DocBlock formatting for pre_site_option filter.

Includes bringing some consistency with the pre_option filter DocBlock.
.
Follow-up to [54145], [54948], [60959].

Props mukesh27, SergeyBiryukov.
See #37930, #63166.

File:

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

trunk/src/wp-includes/option.php

@@ -133 +133 @@
 
     /**
-     * Filters the value of all existing options before it is retrieved.
+     * Filters the value of any existing option before it is retrieved.
      *
      * Returning a value other than false from the filter will short-circuit retrieval
@@ -2039 +2039 @@
 
     /**
-     * Filters the value of an existing network options before it is retrieved.
+     * Filters the value of any existing network option before it is retrieved.
      *
      * Returning a value other than false from the filter will short-circuit retrieval
@@ -2046 +2046 @@
      * @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.
+     * @param mixed  $pre_option    The value to return instead of the network option value. This differs
+     *                              from `$default_value`, 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 );