W3cubDocs

/WordPress

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

Register and configure an admin screen option

Description

Parameters

$option

(string) (Required) An option name.

$args

(mixed) (Optional) Option-dependent arguments.

Default value: array()

Source

File: wp-admin/includes/screen.php

function add_screen_option( $option, $args = array() ) {
	$current_screen = get_current_screen();

	if ( ! $current_screen ) {
		return;
	}

	$current_screen->add_option( $option, $args );
}

Changelog

Version Description
3.1.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/add_screen_option