add_screen_option( string $option, mixed $args = array() )
Register and configure an admin screen option
Description Description
Parameters Parameters
- $option
-
(string) (Required) An option name.
- $args
-
(mixed) (Optional) Option-dependent arguments.
Default value: array()
Source 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
Changelog Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
Example
Change default columns for network dashboard
add_action( 'wp_network_dashboard_setup', function() { add_screen_option( 'layout_columns', array( 'default' => 2 ) ); } );