get_current_screen(): WP_Screen|null

User Contributed Notes

1. Skip to note 11 content

   Rami Yushuvaev 8 years ago

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

   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

   • If you want to set the screen to the front page do this:

     set_current_screen( 'front' );

     This could be useful in unit tests

     carlosenam 5 years ago
2. Skip to note 12 content

   Tim Nolte 4 years ago

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

   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.
       }
3. Skip to note 13 content

   Codex 10 years ago

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

   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
       }
   }
   
   ?>
4. Skip to note 14 content

   Graeme Fulton