From 690481f8e8d17874127919a1067d5248784c6e82 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <info@drewapicture.com>
Date: Mon, 3 Mar 2014 17:51:14 +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.

Built from https://develop.svn.wordpress.org/trunk@27379


git-svn-id: http://core.svn.wordpress.org/trunk@27228 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-admin/includes/misc.php | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/wp-admin/includes/misc.php b/wp-admin/includes/misc.php
index 3c341ba64c..3680f8e5a9 100644
--- a/wp-admin/includes/misc.php
+++ b/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.
 				 */