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

Timestamp:

07/06/2017 03:11:32 PM (9 years ago)

Author:

DrewAPicture

Message:

Options: Pass $default as a new parameter to the pre_option_{$option} and pre_site_option_{$option} filters.

This change standardizes some language in the parameter descriptions between the two hook docs in an effort to reduce confusion between the $pre_option pseudo-parameters and the new $default ones. $pre_option is the truthy value used to short-circuit the get_*option() call, $default is the value passed to the get_*option() returned in the event that 1) a short circuit isn't performed, 2) the option doesn't exist.

Props sc0ttkclark.
Fixes #41254.

File:

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

trunk/src/wp-includes/option.php

@@ -45 +45 @@
          * @since 1.5.0
          * @since 4.4.0 The `$option` parameter was added.
-         *
-         * @param bool|mixed $pre_option Value to return instead of the option value.
-         *                               Default false to skip it.
+         * @since 4.9.0 The `$default` parameter was added.
+         *
+         *
+         * @param bool|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     Option name.
-         */
-        $pre = apply_filters( "pre_option_{$option}", false, $option );
+         * @param mixed      $default    The fallback value to return if the option does not exist.
+         *                               Default is false.
+         */
+        $pre = apply_filters( "pre_option_{$option}", false, $option, $default );
+
         if ( false !== $pre )
                 return $pre;
@@ -1117 +1124 @@
          * @since 4.4.0 The `$option` parameter was added.
          * @since 4.7.0 The `$network_id` parameter was added.
-         *
-         * @param mixed  $pre_option The default value to return if the option does not exist.
+         * @since 4.9.0 The `$default` parameter was added.
+         *
+         * @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_network_option(). Default
+         *                           is false (to skip past the short-circuit).
          * @param string $option     Option name.
          * @param int    $network_id ID of the network.
-         */
-        $pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id );
+         * @param mixed  $default    The fallback value to return if the option does not exist.
+         *                           Default is false.
+         */
+        $pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default );
 
         if ( false !== $pre ) {