WordPress.org

Make WordPress Core

Changeset 27379


Ignore:
Timestamp:
03/03/2014 05:50:33 PM (7 years ago)
Author:
DrewAPicture
Message:

Generalize the hook documentation for the set-screen-option filter.

The filter covers more than [items]_per_page screen options.

Fixes #26186.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/misc.php

    r27375 r27379  
    406406
    407407                /**
    408                  * Filter the default of number of rows value to use for item listings.
     408                 * Filter a screen option value before it is set.
     409                 *
     410                 * The filter can also be used to modify non-standard [items]_per_page
     411                 * settings. See the parent function for a full list of standard options.
     412                 *
     413                 * Returning false to the filter will skip saving the current option.
    409414                 *
    410415                 * @since 2.8.0
    411416                 *
    412                  * @param bool|int $value  The number of rows value. Default false.
     417                 * @see set_screen_options()
     418                 *
     419                 * @param bool|int $value  Screen option value. Default false to skip.
    413420                 * @param string   $option The option name.
    414421                 * @param int      $value  The number of rows to use.
Note: See TracChangeset for help on using the changeset viewer.