add_screen_option( string $option, mixed $args = array() )

Parameters

$optionstring

An option name.

$argsmixedoptional

Option-dependent arguments.Default: array()

Uses · 1

• get_current_screen()Get the current screen object

Source

View on Trac ↗View on GitHub ↗

205function add_screen_option( $option, $args = array() ) {206	$current_screen = get_current_screen();207 208	if ( ! $current_screen ) {209		return;210	}211 212	$current_screen->add_option( $option, $args );213}

History

Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

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

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-admin/includes/screen.php, 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.