Changeset 48244

Timestamp:

07/01/2020 09:43:25 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Administration: Pass the result of set-screen-option filter to the new set_screen_option_{$option} filter to ensure backward compatibility.

Rename the $keep parameter of both filters to $screen_option for clarity, update the documentation to better reflect its purpose.

Follow-up to [47951].

Props Chouby, sswells, SergeyBiryukov.
Merges [48241] to the 5.4 branch.
Fixes #50392.

Location:

branches/5.4

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/misc.php (modified) (3 diffs)

branches/5.4/src/wp-admin/includes/misc.php

@@ -687 +687 @@
                 break;
             default:
+                $screen_option = false;
+
                 if ( '_page' === substr( $option, -5 ) || 'layout_columns' === $option ) {
                     /**
@@ -702 +704 @@
                      * @see set_screen_options()
                      *
-                     * @param bool   $keep   Whether to save or skip saving the screen option value.
-                     *                       Default false.
-                     * @param string $option The option name.
-                     * @param int    $value  The number of rows to use.
+                     * @param mixed  $screen_option The value to save instead of the option value.
+                     *                              Default false (to skip saving the current option).
+                     * @param string $option        The option name.
+                     * @param int    $value         The option value.
                      */
-                    $value = apply_filters( 'set-screen-option', false, $option, $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+                    $screen_option = apply_filters( 'set-screen-option', $screen_option, $option, $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
                 }
 
@@ -721 +723 @@
                  * @see set_screen_options()
                  *
-                 * @param bool   $keep   Whether to save or skip saving the screen option value.
-                 *                       Default false.
-                 * @param string $option The option name.
-                 * @param int    $value  The number of rows to use.
+                 * @param mixed   $screen_option The value to save instead of the option value.
+                 *                               Default false (to skip saving the current option).
+                 * @param string  $option        The option name.
+                 * @param int     $value         The option value.
                  */
-                $value = apply_filters( "set_screen_option_{$option}", false, $option, $value );
+                $value = apply_filters( "set_screen_option_{$option}", $screen_option, $option, $value );
 
                 if ( false === $value ) {