WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / capabilities.php
index 30c38b2cbcbc8118d5e787813ba2803489565a15..42133f6febe2732465c234941f4daa6d1ddb0c9e 100644 (file)
  * the name in value of the 'name' key. The capabilities are stored as an array
  * in the value of the 'capability' key.
  *
- * <code>
- * array (
- *             'rolename' => array (
- *                     'name' => 'rolename',
- *                     'capabilities' => array()
- *             )
- * )
- * </code>
+ *     array (
+ *             'rolename' => array (
+ *                     'name' => 'rolename',
+ *                     'capabilities' => array()
+ *             )
+ *     )
  *
  * @since 2.0.0
  * @package WordPress
@@ -89,10 +87,13 @@ class WP_Roles {
         *
         * @param callable $name      Method to call.
         * @param array    $arguments Arguments to pass when calling.
-        * @return mixed|bool Return value of the callback, false otherwise.
+        * @return mixed|false Return value of the callback, false otherwise.
         */
        public function __call( $name, $arguments ) {
-               return call_user_func_array( array( $this, $name ), $arguments );
+               if ( '_init' === $name ) {
+                       return call_user_func_array( array( $this, $name ), $arguments );
+               }
+               return false;
        }
 
        /**
@@ -104,7 +105,8 @@ class WP_Roles {
         *
         * @since 2.1.0
         * @access protected
-        * @uses $wpdb Used to get the database prefix.
+        *
+        * @global wpdb  $wpdb          WordPress database abstraction object.
         * @global array $wp_user_roles Used to set the 'roles' property value.
         */
        protected function _init() {
@@ -136,6 +138,8 @@ class WP_Roles {
         *
         * @since 3.5.0
         * @access public
+        *
+        * @global wpdb $wpdb
         */
        public function reinit() {
                // There is no need to reinit if using the wp_user_roles global.
@@ -172,7 +176,7 @@ class WP_Roles {
         * @param string $role Role name.
         * @param string $display_name Role display name.
         * @param array $capabilities List of role capabilities in the above format.
-        * @return WP_Role|null WP_Role object if role is added, null if already exists.
+        * @return WP_Role|void WP_Role object, if role is added.
         */
        public function add_role( $role, $display_name, $capabilities = array() ) {
                if ( isset( $this->roles[$role] ) )
@@ -337,7 +341,6 @@ class WP_Role {
        /**
         * Assign role a capability.
         *
-        * @see WP_Roles::add_cap() Method uses implementation for role.
         * @since 2.0.0
         * @access public
         *
@@ -345,13 +348,8 @@ class WP_Role {
         * @param bool $grant Whether role has capability privilege.
         */
        public function add_cap( $cap, $grant = true ) {
-               global $wp_roles;
-
-               if ( ! isset( $wp_roles ) )
-                       $wp_roles = new WP_Roles();
-
                $this->capabilities[$cap] = $grant;
-               $wp_roles->add_cap( $this->name, $cap, $grant );
+               wp_roles()->add_cap( $this->name, $cap, $grant );
        }
 
        /**
@@ -368,13 +366,8 @@ class WP_Role {
         * @param string $cap Capability name.
         */
        public function remove_cap( $cap ) {
-               global $wp_roles;
-
-               if ( ! isset( $wp_roles ) )
-                       $wp_roles = new WP_Roles();
-
                unset( $this->capabilities[$cap] );
-               $wp_roles->remove_cap( $this->name, $cap );
+               wp_roles()->remove_cap( $this->name, $cap );
        }
 
        /**
@@ -416,16 +409,31 @@ class WP_Role {
  * @since 2.0.0
  * @package WordPress
  * @subpackage User
+ *
+ * @property string $nickname
+ * @property string $user_description
+ * @property string $user_firstname
+ * @property string $user_lastname
+ * @property string $user_login
+ * @property string $user_pass
+ * @property string $user_nicename
+ * @property string $user_email
+ * @property string $user_url
+ * @property string $user_registered
+ * @property string $user_activation_key
+ * @property string $user_status
+ * @property string $display_name
+ * @property string $spam
+ * @property string $deleted
  */
 class WP_User {
        /**
         * User data container.
         *
         * @since 2.0.0
-        * @access private
-        * @var array
+        * @var object
         */
-       var $data;
+       public $data;
 
        /**
         * The user's ID.
@@ -481,6 +489,11 @@ class WP_User {
         */
        var $filter = null;
 
+       /**
+        * @static
+        * @access private
+        * @var array
+        */
        private static $back_compat_keys;
 
        /**
@@ -491,10 +504,11 @@ class WP_User {
         * @since 2.0.0
         * @access public
         *
+        * @global wpdb $wpdb
+        *
         * @param int|string|stdClass|WP_User $id User's ID, a WP_User object, or a user object from the DB.
         * @param string $name Optional. User's username
         * @param int $blog_id Optional Blog ID, defaults to current blog.
-        * @return WP_User
         */
        public function __construct( $id = 0, $name = '', $blog_id = '' ) {
                if ( ! isset( self::$back_compat_keys ) ) {
@@ -509,7 +523,7 @@ class WP_User {
                        );
                }
 
-               if ( is_a( $id, 'WP_User' ) ) {
+               if ( $id instanceof WP_User ) {
                        $this->init( $id->data, $blog_id );
                        return;
                } elseif ( is_object( $id ) ) {
@@ -522,13 +536,17 @@ class WP_User {
                        $id = 0;
                }
 
-               if ( $id )
+               if ( $id ) {
                        $data = self::get_data_by( 'id', $id );
-               else
+               } else {
                        $data = self::get_data_by( 'login', $name );
+               }
 
-               if ( $data )
+               if ( $data ) {
                        $this->init( $data, $blog_id );
+               } else {
+                       $this->data = new stdClass;
+               }
        }
 
        /**
@@ -549,9 +567,13 @@ class WP_User {
         *
         * @since 3.3.0
         *
+        * @static
+        *
+        * @global wpdb $wpdb
+        *
         * @param string $field The field to query against: 'id', 'slug', 'email' or 'login'
         * @param string|int $value The field value
-        * @return object Raw user object
+        * @return object|false Raw user object
         */
        public static function get_data_by( $field, $value ) {
                global $wpdb;
@@ -608,10 +630,29 @@ class WP_User {
                return $user;
        }
 
+       /**
+        * Makes private/protected methods readable for backwards compatibility.
+        *
+        * @since 4.3.0
+        * @access public
+        *
+        * @param callable $name      Method to call.
+        * @param array    $arguments Arguments to pass when calling.
+        * @return mixed|false Return value of the callback, false otherwise.
+        */
+       public function __call( $name, $arguments ) {
+               if ( '_init_caps' === $name ) {
+                       return call_user_func_array( array( $this, $name ), $arguments );
+               }
+               return false;
+       }
+
        /**
         * Magic method for checking the existence of a certain custom field
         *
         * @since 3.3.0
+        * @param string $key
+        * @return bool
         */
        public function __isset( $key ) {
                if ( 'id' == $key ) {
@@ -632,6 +673,8 @@ class WP_User {
         * Magic method for accessing custom fields
         *
         * @since 3.3.0
+        * @param string $key
+        * @return mixed
         */
        public function __get( $key ) {
                if ( 'id' == $key ) {
@@ -689,6 +732,7 @@ class WP_User {
         * @since 3.3.0
         *
         * @param string $key Property
+        * @return mixed
         */
        public function get( $key ) {
                return $this->__get( $key );
@@ -702,6 +746,7 @@ class WP_User {
         * @since 3.3.0
         *
         * @param string $key Property
+        * @return bool
         */
        public function has_prop( $key ) {
                return $this->__isset( $key );
@@ -729,9 +774,11 @@ class WP_User {
         * @access protected
         * @since 2.1.0
         *
+        * @global wpdb $wpdb
+        *
         * @param string $cap_key Optional capability key
         */
-       function _init_caps( $cap_key = '' ) {
+       protected function _init_caps( $cap_key = '' ) {
                global $wpdb;
 
                if ( empty($cap_key) )
@@ -756,16 +803,12 @@ class WP_User {
         * granted permission to.
         *
         * @since 2.0.0
-        * @uses $wp_roles
         * @access public
         *
         * @return array List of all capabilities for the user.
         */
        public function get_role_caps() {
-               global $wp_roles;
-
-               if ( ! isset( $wp_roles ) )
-                       $wp_roles = new WP_Roles();
+               $wp_roles = wp_roles();
 
                //Filter out caps that are not role names and assign to $this->roles
                if ( is_array( $this->caps ) )
@@ -797,6 +840,16 @@ class WP_User {
                update_user_meta( $this->ID, $this->cap_key, $this->caps );
                $this->get_role_caps();
                $this->update_user_level_from_caps();
+
+               /**
+                * Fires immediately after the user has been given a new role.
+                *
+                * @since 4.3.0
+                *
+                * @param int    $user_id The user ID.
+                * @param string $role    The new role.
+                */
+               do_action( 'add_user_role', $this->ID, $role );
        }
 
        /**
@@ -814,6 +867,16 @@ class WP_User {
                update_user_meta( $this->ID, $this->cap_key, $this->caps );
                $this->get_role_caps();
                $this->update_user_level_from_caps();
+
+               /**
+                * Fires immediately after a role as been removed from a user.
+                *
+                * @since 4.3.0
+                *
+                * @param int    $user_id The user ID.
+                * @param string $role    The removed role.
+                */
+               do_action( 'remove_user_role', $this->ID, $role );
        }
 
        /**
@@ -896,6 +959,8 @@ class WP_User {
         *
         * @since 2.0.0
         * @access public
+        *
+        * @global wpdb $wpdb
         */
        public function update_user_level_from_caps() {
                global $wpdb;
@@ -915,6 +980,8 @@ class WP_User {
        public function add_cap( $cap, $grant = true ) {
                $this->caps[$cap] = $grant;
                update_user_meta( $this->ID, $this->cap_key, $this->caps );
+               $this->get_role_caps();
+               $this->update_user_level_from_caps();
        }
 
        /**
@@ -926,10 +993,13 @@ class WP_User {
         * @param string $cap Capability name.
         */
        public function remove_cap( $cap ) {
-               if ( ! isset( $this->caps[$cap] ) )
+               if ( ! isset( $this->caps[ $cap ] ) ) {
                        return;
-               unset( $this->caps[$cap] );
+               }
+               unset( $this->caps[ $cap ] );
                update_user_meta( $this->ID, $this->cap_key, $this->caps );
+               $this->get_role_caps();
+               $this->update_user_level_from_caps();
        }
 
        /**
@@ -937,6 +1007,8 @@ class WP_User {
         *
         * @since 2.1.0
         * @access public
+        *
+        * @global wpdb $wpdb
         */
        public function remove_all_caps() {
                global $wpdb;
@@ -982,7 +1054,7 @@ class WP_User {
                 * @since 2.0.0
                 * @since 3.7.0 Added the user object.
                 *
-                * @param array   $allcaps An array of all the role's capabilities.
+                * @param array   $allcaps An array of all the user's capabilities.
                 * @param array   $caps    Actual capabilities for meta capability.
                 * @param array   $args    Optional parameters passed to has_cap(), typically object ID.
                 * @param WP_User $user    The user object.
@@ -1018,6 +1090,8 @@ class WP_User {
         *
         * @since 3.0.0
         *
+        * @global wpdb $wpdb
+        *
         * @param int $blog_id Optional Blog ID, defaults to current blog.
         */
        public function for_blog( $blog_id = '' ) {
@@ -1114,8 +1188,10 @@ function map_meta_cap( $cap, $user_id ) {
        case 'edit_post':
        case 'edit_page':
                $post = get_post( $args[0] );
-               if ( empty( $post ) )
+               if ( empty( $post ) ) {
+                       $caps[] = 'do_not_allow';
                        break;
+               }
 
                if ( 'revision' == $post->post_type ) {
                        $post = get_post( $post->post_parent );
@@ -1205,8 +1281,8 @@ function map_meta_cap( $cap, $user_id ) {
                        /**
                         * Filter whether the user is allowed to add post meta to a post.
                         *
-                        * The dynamic portion of the hook name, $meta_key, refers to the
-                        * meta key passed to map_meta_cap().
+                        * The dynamic portion of the hook name, `$meta_key`, refers to the
+                        * meta key passed to {@see map_meta_cap()}.
                         *
                         * @since 3.3.0
                         *
@@ -1229,7 +1305,16 @@ function map_meta_cap( $cap, $user_id ) {
                if ( empty( $comment ) )
                        break;
                $post = get_post( $comment->comment_post_ID );
-               $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
+
+               /*
+                * If the post doesn't exist, we have an orphaned comment.
+                * Fall back to the edit_posts capability, instead.
+                */
+               if ( $post ) {
+                       $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
+               } else {
+                       $caps = map_meta_cap( 'edit_posts', $user_id );
+               }
                break;
        case 'unfiltered_upload':
                if ( defined('ALLOW_UNFILTERED_UPLOADS') && ALLOW_UNFILTERED_UPLOADS && ( !is_multisite() || is_super_admin( $user_id ) )  )
@@ -1302,7 +1387,7 @@ function map_meta_cap( $cap, $user_id ) {
        case 'create_users':
                if ( !is_multisite() )
                        $caps[] = $cap;
-               elseif ( is_super_admin() || get_site_option( 'add_new_users' ) )
+               elseif ( is_super_admin( $user_id ) || get_site_option( 'add_new_users' ) )
                        $caps[] = $cap;
                else
                        $caps[] = 'do_not_allow';
@@ -1316,6 +1401,9 @@ function map_meta_cap( $cap, $user_id ) {
        case 'customize' :
                $caps[] = 'edit_theme_options';
                break;
+       case 'delete_site':
+               $caps[] = 'manage_options';
+               break;
        default:
                // Handle meta capabilities for custom post types.
                $post_type_meta_caps = _post_type_meta_capabilities();
@@ -1371,21 +1459,25 @@ function current_user_can( $capability ) {
  * @return bool
  */
 function current_user_can_for_blog( $blog_id, $capability ) {
-       if ( is_multisite() )
-               switch_to_blog( $blog_id );
+       $switched = is_multisite() ? switch_to_blog( $blog_id ) : false;
 
        $current_user = wp_get_current_user();
 
-       if ( empty( $current_user ) )
+       if ( empty( $current_user ) ) {
+               if ( $switched ) {
+                       restore_current_blog();
+               }
                return false;
+       }
 
        $args = array_slice( func_get_args(), 2 );
        $args = array_merge( array( $capability ), $args );
 
        $can = call_user_func_array( array( $current_user, 'has_cap' ), $args );
 
-       if ( is_multisite() )
+       if ( $switched ) {
                restore_current_blog();
+       }
 
        return $can;
 }
@@ -1436,28 +1528,39 @@ function user_can( $user, $capability ) {
        return call_user_func_array( array( $user, 'has_cap' ), $args );
 }
 
+/**
+ * Retrieves the global WP_Roles instance and instantiates it if necessary.
+ *
+ * @since 4.3.0
+ *
+ * @global WP_Roles $wp_roles WP_Roles global instance.
+ *
+ * @return WP_Roles WP_Roles global instance if not already instantiated.
+ */
+function wp_roles() {
+       global $wp_roles;
+
+       if ( ! isset( $wp_roles ) ) {
+               $wp_roles = new WP_Roles();
+       }
+       return $wp_roles;
+}
+
 /**
  * Retrieve role object.
  *
- * @see WP_Roles::get_role() Uses method to retrieve role object.
  * @since 2.0.0
  *
  * @param string $role Role name.
  * @return WP_Role|null WP_Role object if found, null if the role does not exist.
  */
 function get_role( $role ) {
-       global $wp_roles;
-
-       if ( ! isset( $wp_roles ) )
-               $wp_roles = new WP_Roles();
-
-       return $wp_roles->get_role( $role );
+       return wp_roles()->get_role( $role );
 }
 
 /**
  * Add role, if it does not exist.
  *
- * @see WP_Roles::add_role() Uses method to add role.
  * @since 2.0.0
  *
  * @param string $role Role name.
@@ -1466,29 +1569,18 @@ function get_role( $role ) {
  * @return WP_Role|null WP_Role object if role is added, null if already exists.
  */
 function add_role( $role, $display_name, $capabilities = array() ) {
-       global $wp_roles;
-
-       if ( ! isset( $wp_roles ) )
-               $wp_roles = new WP_Roles();
-
-       return $wp_roles->add_role( $role, $display_name, $capabilities );
+       return wp_roles()->add_role( $role, $display_name, $capabilities );
 }
 
 /**
  * Remove role, if it exists.
  *
- * @see WP_Roles::remove_role() Uses method to remove role.
  * @since 2.0.0
  *
  * @param string $role Role name.
  */
 function remove_role( $role ) {
-       global $wp_roles;
-
-       if ( ! isset( $wp_roles ) )
-               $wp_roles = new WP_Roles();
-
-       $wp_roles->remove_role( $role );
+       wp_roles()->remove_role( $role );
 }
 
 /**
@@ -1496,7 +1588,7 @@ function remove_role( $role ) {
  *
  * @since 3.0.0
  *
- * @uses $super_admins Super admins global variable, if set.
+ * @global array $super_admins
  *
  * @return array List of super admin logins
  */