wppaste
WordPress

apply_filters( "set_screen_option_{$option}", mixed $screen_option, string $option, int $value )

Since
5.4.2
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.

Compatibility

WordPress
since 5.4.2
  • 6.7.10
  • 6.8.11
  • 6.9.10
  • 7.0.7
  • 7.1.3

Present in every tracked release (6.7.10 to 7.1.3).

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.

Where this hook fires · 1

  • wp-admin/includes/misc.php:792set_screen_options()

Source code

			 *			 * @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.			 */			$value = apply_filters( "set_screen_option_{$option}", $screen_option, $option, $value ); 			if ( false === $value ) {				return;			} 			break;

Changelog

Introduced in 5.4.2. Unchanged from 6.7.10 through 7.1.3.

  1. 6.7.10
  2. 6.8.11
  3. 6.9.10
  4. 7.0.7
  5. 7.1.3

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.8.11 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.