From b8dea76b495f0072523106c6ec46b9ea0d2a0920 Mon Sep 17 00:00:00 2001 From: Jonathan Desrosiers Date: Wed, 10 Jun 2020 17:46:52 +0000 Subject: [PATCH] Administration: Add a new filter to extend set-screen-option. Merges [47951] to the 5.4 branch. Props: xknown, SergeyBiryukov. git-svn-id: https://develop.svn.wordpress.org/branches/5.4@47957 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/misc.php | 37 +++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/src/wp-admin/includes/misc.php b/src/wp-admin/includes/misc.php index 736dba8f3e..a21aaca751 100644 --- a/src/wp-admin/includes/misc.php +++ b/src/wp-admin/includes/misc.php @@ -686,23 +686,46 @@ function set_screen_options() { } break; default: + if ( '_page' === substr( $option, -5 ) || 'layout_columns' === $option ) { + /** + * Filters a screen option value before it is set. + * + * The filter can also be used to modify non-standard [items]_per_page + * settings. See the parent function for a full list of standard options. + * + * Returning false to the filter will skip saving the current option. + * + * @since 2.8.0 + * @since 5.4.2 Only applied to options ending with '_page', + * or the 'layout_columns' option. + * + * @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. + */ + $value = apply_filters( 'set-screen-option', false, $option, $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores + } + /** * Filters a screen option value before it is set. * - * The filter can also be used to modify non-standard [items]_per_page - * settings. See the parent function for a full list of standard options. + * The dynamic portion of the hook, `$option`, refers to the option name. * * Returning false to the filter will skip saving the current option. * - * @since 2.8.0 + * @since 5.4.2 * * @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 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. */ - $value = apply_filters( 'set-screen-option', false, $option, $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores + $value = apply_filters( "set_screen_option_{$option}", false, $option, $value ); if ( false === $value ) { return;