Changeset 21687 for trunk/wp-admin/includes/screen.php

Timestamp:

08/31/2012 05:16:46 PM (12 years ago)

Author:

ryan

Message:

Introduce WP_Screen::in_admin() for determining which admin the screen is in.
Change is_*_admin() to reference in_admin() with fallback to the WP_*_ADMIN constants during early bootstrap. This allows unit tests and ajax handlers to set the admin context.

fixes #21742

File:

• trunk/wp-admin/includes/screen.php (modified) (8 diffs)

trunk/wp-admin/includes/screen.php

@@ -245 +245 @@
 
     /**
+     * Which admin the screen is in. network | user | site | false
+     *
+     * @since 3.5.0
+     * @var string
+     * @access protected
+     */
+    protected $in_admin;
+
+    /**
      * Whether the screen is in the network admin.
      *
-     * @since 3.3.0
+     * Deprecated. Use in_admin() instead.
+     *
+     * @since 3.3.0
+     * @deprecated 3.5.0
      * @var bool
      * @access public
@@ -256 +268 @@
      * Whether the screen is in the user admin.
      *
-     * @since 3.3.0
+     * Deprecated. Use in_admin() instead.
+     *
+     * @since 3.3.0
+     * @deprecated 3.5.0
      * @var bool
      * @access public
@@ -378 +393 @@
 
         $post_type = $taxonomy = null;
-        $is_network = $is_user = false;
+        $in_admin = false;
         $action = '';
 
@@ -403 +418 @@
             if ( '-network' == substr( $id, -8 ) ) {
                 $id = substr( $id, 0, -8 );
-                $is_network = true;
+                $in_admin = 'network';
             } elseif ( '-user' == substr( $id, -5 ) ) {
                 $id = substr( $id, 0, -5 );
-                $is_user = true;
+                $in_admin = 'user';
             }
 
@@ -420 +435 @@
                 }
             }
+
+            if ( ! $in_admin )
+                $in_admin = 'site';
         } else {
-            $is_network = is_network_admin();
-            $is_user = is_user_admin();
+            if ( defined( 'WP_NETWORK_ADMIN' ) && WP_NETWORK_ADMIN )
+                $in_admin = 'network';
+            elseif ( defined( 'WP_USER_ADMIN' ) && WP_USER_ADMIN )
+                $in_admin = 'user';
+            else
+                $in_admin = 'site';
         }
 
         if ( 'index' == $id )
             $id = 'dashboard';
+        elseif ( 'front' == $id )
+            $in_admin = false;
 
         $base = $id;
@@ -477 +501 @@
         }
 
-        if ( $is_network ) {
+        if ( 'network' == $in_admin ) {
             $id   .= '-network';
             $base .= '-network';
-        } elseif ( $is_user ) {
+        } elseif ( 'user' == $in_admin ) {
             $id   .= '-user';
             $base .= '-user';
@@ -498 +522 @@
         $screen->post_type  = (string) $post_type;
         $screen->taxonomy   = (string) $taxonomy;
-        $screen->is_user    = $is_user;
-        $screen->is_network = $is_network;
+        $screen->is_user    = ( 'user' == $in_admin );
+        $screen->is_network = ( 'network' == $in_admin );
+        $screen->in_admin   = $in_admin;
 
         self::$_registry[ $id ] = $screen;
@@ -527 +552 @@
      */
     private function __construct() {}
+
+    /**
+     * Indicates whether the screen is in a particular admin
+     *
+     * @since 3.5.0
+     *
+     * @param string $admin The admin to check against (network | user | site).
+     * If empty any of the three admins will result in true.
+     * @return boolean True if the screen is in the indicated admin, false otherwise.
+     *
+     */
+    public function in_admin( $admin = null ) {
+        if ( empty( $admin ) )
+            return (bool) $this->in_admin;
+
+        return ( $admin == $this->in_admin );
+    }
 
     /**