W3cubDocs

/WordPress

apply_filters( ‘set-screen-option’, mixed $screen_option, string $option, int $value )

Filters a screen option value before it is set.

Description

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.

See also

Parameters

$screen_optionmixed
The value to save instead of the option value.
Default false (to skip saving the current option).
$optionstring
The option name.
$valueint
The option value.

Source

$screen_option = apply_filters( 'set-screen-option', $screen_option, $option, $value ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores

View all references View on Trac View on GitHub

Changelog

Version Description
5.4.2 Only applied to options ending with '_page', or the 'layout_columns' option.
2.8.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/set-screen-option