Changeset 48241

Timestamp:

06/30/2020 09:51:47 PM (6 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.

Props Chouby, sswells, SergeyBiryukov.
Fixes #50392.

File:

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

trunk/src/wp-admin/includes/misc.php

@@ -689 +689 @@
                                 break;
                         default:
+                                $screen_option = false;
+
                                 if ( '_page' === substr( $option, -5 ) || 'layout_columns' === $option ) {
                                         /**
@@ -704 +706 @@
                                          * @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
                                 }
 
@@ -723 +725 @@
                                  * @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 ) {