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

Register and configure an admin screen option

Contents

Parameters
Source
Related
- Uses
Changelog
User Contributed Notes

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 );
}

Expand full source code Collapse full source code View on Trac View on GitHub

Uses

Uses
Uses	Description
wp-admin/includes/screen.php: get_current_screen()	Get the current screen object

Changelog

Changelog
Version	Description
3.1.0	Introduced.

User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

Contributed by giangel84 — 3 years ago
The $option parameter define the object (input or radio button) which will be printed to the screen option section.

add_screen_option only accept 2 methods:
- 1. ‘per_page’
- 2. ‘layout_columns’
Example 1:
```
add_screen_option( 'per_page', array( 'label' => 'My Label', 'default' => 1, 'option' => 'option_name' ) );
```
will print
```
<input type="number" step="1" min="1" max="999" class="screen-per-page" name="wp_screen_options[value]" id="option_name" maxlength="3" value="1">
```
Example 2:
```
add_screen_option( 'layout_columns', array( 'max' => 2, 'default' => 2 ) );
```
will print
```
<input type="radio" name="screen_columns" value="1">
<input type="radio" name="screen_columns" value="2" checked="checked">
```
add_screen_option not support the checkboxes method yet.
Log in to add feedback
Skip to note 2 content

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Contributed by Codex — 6 years ago
Example

Change default columns for network dashboard
```
add_action( 'wp_network_dashboard_setup', function() {
    add_screen_option( 'layout_columns', array( 'default' => 2 ) );
} );
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.