Filter hook 'set-screen-option'

in WP Core File wp-admin/includes/misc.php at line 773

Description

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 from the filter will skip saving the current option. or the 'layout_columns' option.

Occurrences

Filename Line Number
wp-admin/includes/misc.php 773

Parameters

Type Name Description
mixed $screen_option The value to save instead of the option value. Default false (to skip saving the current option).
string $option The option name.
int $value The option value.

PHP Doc

/**
				 * 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 from 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 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.
				 */