get_current_screen(): WP_Screen|null

Get the current screen object

Contents

Return

WP_Screen|null Current screen object or null when screen not defined.

Top ↑

Source

File: wp-admin/includes/screen.php. View all references 

function get_current_screen() {
	global $current_screen;

	if ( ! isset( $current_screen ) ) {
		return null;
	}

	return $current_screen;
}

View on Trac View on GitHub

Top ↑

Top ↑

Used By

Used By
Used By Description
wp_global_styles_render_svg_filters() wp-includes/script-loader.php

Renders the SVG filters supplied by theme.json.
WP_Site_Health::admin_body_class() wp-admin/includes/class-wp-site-health.php

Add a class to the body HTML tag.
WP_Site_Health::enqueue_scripts() wp-admin/includes/class-wp-site-health.php

Enqueues the site health scripts.
WP_Privacy_Policy_Content::notice() wp-admin/includes/class-wp-privacy-policy-content.php

Add a notice with a link to the guide when editing the privacy policy page.
WP_Privacy_Policy_Content::policy_text_changed_notice() wp-admin/includes/class-wp-privacy-policy-content.php

Output a warning when some privacy info has changed.
_wp_privacy_settings_filter_draft_page_titles() wp-admin/includes/misc.php

Appends ‘(Draft)’ to draft page titles in the privacy page dropdown so that unpublished content is obvious.
WP_Widget_Custom_HTML::add_help_text() wp-includes/widgets/class-wp-widget-custom-html.php

Add help text to widgets admin screen.
wp_ajax_search_install_plugins() wp-admin/includes/ajax-actions.php

Ajax handler for searching plugins to install.
wp_ajax_search_plugins() wp-admin/includes/ajax-actions.php

Ajax handler for searching plugins.
WP_Screen::render_view_mode() wp-admin/includes/class-wp-screen.php

Render the list table view mode preferences.
WP_Screen::get() wp-admin/includes/class-wp-screen.php

Fetches a screen object.
add_screen_option() wp-admin/includes/screen.php

Register and configure an admin screen option
screen_layout() wp-admin/includes/deprecated.php

Returns the screen layout options.
screen_options() wp-admin/includes/deprecated.php

Returns the screen’s per-page options.
screen_meta() wp-admin/includes/deprecated.php

Renders the screen’s help.
wp_plugin_update_row() wp-admin/includes/update.php

Displays update information for a plugin.
wp_add_dashboard_widget() wp-admin/includes/dashboard.php

Adds a new dashboard widget.
wp_dashboard() wp-admin/includes/dashboard.php

Displays the dashboard.
wp_dashboard_setup() wp-admin/includes/dashboard.php

Registers dashboard widgets.
_get_list_table() wp-admin/includes/list-table.php

Fetches an instance of a WP_List_Table class.
iframe_header() wp-admin/includes/template.php

Generic Iframe header for use with Thickbox.
add_meta_box() wp-admin/includes/template.php

Adds a meta box to one or more screens.
do_meta_boxes() wp-admin/includes/template.php

Meta-Box template function.
remove_meta_box() wp-admin/includes/template.php

Removes a meta box from one or more screens.
do_accordion_sections() wp-admin/includes/template.php

Meta Box Accordion Template Function.
post_comment_meta_box() wp-admin/includes/meta-boxes.php

Displays comments for post.
page_attributes_meta_box() wp-admin/includes/meta-boxes.php

Displays page attributes form fields.
Custom_Image_Header::help() wp-admin/includes/class-custom-image-header.php

Adds contextual help.
Custom_Background::admin_load() wp-admin/includes/class-custom-background.php

Set up the enqueue for the CSS & JavaScript files.
wp_auth_check_load() wp-includes/functions.php

Load the auth check for monitoring whether the user is still logged in.
wp_admin_bar_edit_menu() wp-includes/admin-bar.php

Provides an edit link for posts and terms.
Show 26 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
3.1.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 19You must log in to vote on the helpfulness of this note
    Contributed by Rami Yushuvaev — 
    PAGE               $SCREEN_ID           FILE
-----------------  -------------------  -----------------------
Media Library      upload               upload.php
Comments           edit-comments        edit-comments.php
Tags               edit-post_tag        edit-tags.php
Plugins            plugins              plugins.php
Links              link-manager         link-manager.php
Users              users                users.php
Posts              edit-post            edit.php
Pages              edit-page            edit.php
Edit Site: Themes  site-themes-network  network/site-themes.php
Themes             themes-network       network/themes
Users              users-network        network/users
Edit Site: Users   site-users-network   network/site-users
Sites              sites-network        network/sites
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Another Example:

    <?php

add_action( 'current_screen', 'wpdocs_this_screen' );

/**
 * Run code on the admin widgets page
 */
function wpdocs_this_screen() {
    $currentScreen = get_current_screen();
    if( $currentScreen->id === "widgets" ) {
        // Run some code, only on the admin widgets page
    }
}

?>
  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
    Contributed by Graeme Fulton —

    I was trying to find out the name of the admin dashboard.
    You can find out the current screen name by dumping it:

    $my_current_screen = get_current_screen();
var_dump( $my_current_screen->base );

    Using this, I found the dashboard screen is just called ‘dashboard’ 🤯, so I could then redirect to a different page like this:

    /**
 * Redirect specific admin page
 */
add_action( 'current_screen', 'wpdocs_custom_redirect_admin_dashboard' );

function wpdocs_custom_redirect_admin_dashboard() {
    if ( is_admin() ) {
        $my_current_screen = get_current_screen();

        if ( isset( $my_current_screen->base ) && 'dashboard' === $my_current_screen->base ) {
            wp_redirect( admin_url().'?page=custom_dashboard' );
            exit();
        }
    }
}
  4. Skip to note 4 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Jb Audras —

    The fields returned are:

    id (string) The unique ID of the screen
    action (string) Any action associated with the screen. ‘add’ for *-new.php screens. Empty otherwise.
    base (string) The base type of the screen. For example, for a page ‘post-new.php’ the base is ‘post’.
    parent_base (string) The base menu parent. This is derived from $parent_file by removing the query string and any .php extension. For example, parent_file values of ‘edit.php?post_type=page’ and ‘edit.php?post_type=post’ have a parent_base of ‘edit’
    parent_file (string) The parent_file for the screen per the admin menu system. Some parent_file values are ‘edit.php?post_type=page’, ‘edit.php’, and ‘options-general.php’
    post_type (string) The post type associated with the screen, if any. For example, the ‘edit.php?post_type=page’ screen has a post type of ‘page’
    taxonomy (string) The taxonomy associated with the screen, if any. For example, the ‘edit-tags.php?taxonomy=category’ screen has a taxonomy of ‘category’

    Returned object:

    WP_Screen Object
(
    [action] => 
    [base] => post
    [id] => post
    [is_network] => 
    [is_user] => 
    [parent_base] => edit
    [parent_file] => edit.php
    [post_type] => post
    [taxonomy] => 
    ...
    (private fields)
)
  5. Skip to note 5 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Tim Nolte —

    Be aware the this function doesn’t always exist, something that @ravanh had sort of eluded to. It isn’t loaded and available until after admin_init has fired. It is advisable to check whether the function exists when using it within any hooks in the even those hooks fire before that function is actually loaded and available to use.

        /**
     * Check whether the get_current_screen function exists
     * because it is loaded only after 'admin_init' hook.
     */
    if ( function_exists( 'get_current_screen' ) ) {
        $current_screen = get_current_screen();
        // Do your thing.
    }
  6. Skip to note 6 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 Rolf Allard van Hagen —

    Be aware that at the global $current_screen gets set relatively late, right after the admin_init has run. This is done with function set_current_screen() in template files like admin-header.php and admin.php or when processing admin ajax requests.

    Calling set_current_screen() yourself earlier will not help. Although get_current_screen() does not return null anymore, the current screen object will not be populated with the correct properties, like get_current_screen()->$id, to work with.

    Use get_current_screen() at the current_screen hook or later.

  8. Skip to note 8 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 Codex —

    Default Usage
    This example shows how you would add contextual help to an admin page you’ve created with the add_options_page() function. Here, we assume that your admin page has a slug of my_admin_page and exists under the Options tab.

    The get_current_screen() function is used in this example.

    <?php 
add_action('admin_menu', 'wpdocs_admin_add_page');

/**
 * Add an admin page
 */
function wpdocs_admin_add_page() {
	global $wpdocs_admin_page;
	$wpdocs_admin_page = add_options_page(__('Wpdocs Admin Page', 'wpdocs_textdomain'),
		__('Wpdocs Admin Page', 'wpdocs_textdomain'),
		'manage_options', 'wpdocs_textdomain', 'wpdocs_admin_page');

	// Adds my_help_tab when my_admin_page loads
	add_action('load-'.$wpdocs_admin_page, 'wpdocs_admin_add_help_tab');
}

/**
 * Add a contextual help tab to the Wpdocs Admin Page
 */
function wpdocs_admin_add_help_tab () {
    global $wpdocs_admin_page;
    $screen = get_current_screen();

    /*
     * Check if current screen is Wpdocs Admin Page
     * Don't add help tab if it's not
     */
    if ( $screen->id != $wpdocs_admin_page )
        return;

    // Add my_help_tab if current screen is My Admin Page
    $screen->add_help_tab( array(
        'id' => 'wpdocs_help_tab',
        'title' => __('Wpdocs Help Tab'),
        'content' => '<p>'
		. __( 'Descriptive content that will show in Wpdocs Help Tab body goes here.', 'wpdocs_textdomain' )
		. '</p>',
    ) );
}
?>
  9. Skip to note 9 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -2You must log in to vote on the helpfulness of this note
    Contributed by Aurovrata Venet —

    This function is useful to figure out which screen you’re on in the Dashboard,

    add_action('trashed_post', 'trash_wpcrm_contact');
function trash_wpcrm_contact($post_id){
    $screen = get_current_screen();
    if('wpcrm-contact' != $screen->post_type){ //this is not our custom post, so let's exit
      return;
    }
    ....
}

    Another useful attribute of the WP_Screen object returned by this function is the $screen->base attribute which is set to 'post' for any custom post edit screen, and is set to 'edit' for the custom post admin table page, which is very handy when loading custom css/scripts for additional function on those pages.

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