From 1b41eea7c7ee62706eb25ce16e242147c4f0a0af Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Mon, 3 Mar 2014 17:50:33 +0000 Subject: [PATCH] Generalize the hook documentation for the `set-screen-option` filter. The filter covers more than [items]_per_page screen options. Fixes #26186. git-svn-id: https://develop.svn.wordpress.org/trunk@27379 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/misc.php | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/wp-admin/includes/misc.php b/src/wp-admin/includes/misc.php index 3c341ba64c..3680f8e5a9 100644 --- a/src/wp-admin/includes/misc.php +++ b/src/wp-admin/includes/misc.php @@ -405,11 +405,18 @@ function set_screen_options() { default: /** - * Filter the default of number of rows value to use for item listings. + * Filter 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 * - * @param bool|int $value The number of rows value. Default false. + * @see set_screen_options() + * + * @param bool|int $value Screen option value. Default false to skip. * @param string $option The option name. * @param int $value The number of rows to use. */