*
* @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 ) {
if ( '_init' === $name ) {
*
* @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.
* @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] ) )
/**
* Assign role a capability.
*
- * @see WP_Roles::add_cap() Method uses implementation for role.
* @since 2.0.0
* @access public
*
* @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 );
}
/**
* @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 );
}
/**
*/
var $filter = null;
+ /**
+ * @static
+ * @access private
+ * @var array
+ */
private static $back_compat_keys;
/**
* @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.
*
* @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|false Raw user object
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 Property
+ * @return mixed
*/
public function get( $key ) {
return $this->__get( $key );
* @since 3.3.0
*
* @param string $key Property
+ * @return bool
*/
public function has_prop( $key ) {
return $this->__isset( $key );
* @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) )
* 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 ) )
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 );
}
/**
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 );
}
/**
*
* @since 2.0.0
* @access public
+ *
+ * @global wpdb $wpdb
*/
public function update_user_level_from_caps() {
global $wpdb;
*
* @since 2.1.0
* @access public
+ *
+ * @global wpdb $wpdb
*/
public function remove_all_caps() {
global $wpdb;
*
* @since 3.0.0
*
+ * @global wpdb $wpdb
+ *
* @param int $blog_id Optional Blog ID, defaults to current blog.
*/
public function for_blog( $blog_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 );
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 ) ) )
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';
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.
* @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 );
}
/**
*
* @since 3.0.0
*
- * @uses $super_admins Super admins global variable, if set.
+ * @global array $super_admins
*
* @return array List of super admin logins
*/