set_screen_option_{$option} WordPress Filter Hook
The set_screen_option_{$option} hook is used to set the value for a given option on the current screen. The option must be registered with the add_screen_option() function. The hook takes two arguments: the new value for the option and the old value for the option. If the new value is different from the old value, the option will be updated.
apply_filters( "set_screen_option_{$option}", mixed $screen_option , string $option , int $value ) #
Filters a screen option value before it is set.
Description
The dynamic portion of the hook name, $option, refers to the option name.
Returning false from the filter will skip saving the current option.
See also
Parameters
- $screen_option
(mixed)The value to save instead of the option value. Default false (to skip saving the current option).
- $option
(string)The option name.
- $value
(int)The option value.
Source
Changelog
| Version | Description |
|---|---|
| 5.4.2 | Introduced. |