do_action( 'current_screen', WP_Screen $current_screen )
Fires after the current screen has been set.
Parameters
More Information
current_screen is an admin hook triggered after the necessary elements to identify a screen are set up. This hook provides a WP_Screen object as a parameter.
Parameter for hooked function
The following is a sample of the WP_Screen object passed as parameter to a function hooked to current_screen and called in a custom post type editing screen.
WP_Screen Object {
["action"] => string(0) ""
["base"] => string(4) "post"
["columns":"WP_Screen":private] => int(0)
["id"] => string(12) "someposttype"
["in_admin":protected] => string(4) "site"
["is_network"] => bool(false)
["is_user"] => bool(false)
["parent_base"] => NULL
["parent_file"] => NULL
["post_type"] => string(12) "someposttype"
["taxonomy"] => string(0) ""
["_help_tabs":"WP_Screen":private] => array(0) { }
["_help_sidebar":"WP_Screen":private] => string(0) ""
["_options":"WP_Screen":private] => array(0) { }
["_show_screen_options":"WP_Screen":private] => NULL
["_screen_settings":"WP_Screen":private] => NULL
}
and a sample of the object returned in a taxonomy list screen
WP_Screen Object {
["action"] => string(0) ""
["base"] => string(9) "edit-tags"
["columns":"WP_Screen":private] => int(0)
["id"] => string(10) "edit-mytax"
["in_admin":protected] => string(4) "site"
["is_network"] => bool(false)
["is_user"] => bool(false)
["parent_base"] => NULL
["parent_file"] => NULL
["post_type"] => string(12) "someposttype"
["taxonomy"] => string(5) "mytax"
["_help_tabs":"WP_Screen":private] => array(0) { }
["_help_sidebar":"WP_Screen":private] => string(0) ""
["_options":"WP_Screen":private] => array(0) { }
["_show_screen_options":"WP_Screen":private] => NULL
["_screen_settings":"WP_Screen":private] => NULL
}
Source
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/current_screen