* @param string $role Role name.
* @return object|null Null, if role does not exist. WP_Role object, if found.
*/
- function &get_role( $role ) {
+ function get_role( $role ) {
if ( isset( $this->role_objects[$role] ) )
return $this->role_objects[$role];
else
/**
* User data container.
*
- * This will be set as properties of the object.
- *
* @since 2.0.0
* @access private
* @var array
*/
var $ID = 0;
- /**
- * The deprecated user's ID.
- *
- * @since 2.0.0
- * @access public
- * @deprecated Use WP_User::$ID
- * @see WP_User::$ID
- * @var int
- */
- var $id = 0;
-
/**
* The individual capabilities the user has been given.
*
*/
var $allcaps = array();
- /**
- * First name of the user.
- *
- * Created to prevent notices.
- *
- * @since 2.7.0
- * @access public
- * @var string
- */
- var $first_name = '';
-
- /**
- * Last name of the user.
- *
- * Created to prevent notices.
- *
- * @since 2.7.0
- * @access public
- * @var string
- */
- var $last_name = '';
-
/**
* The filter context applied to user data fields.
*
*/
var $filter = null;
+ private static $back_compat_keys;
+
/**
- * Constructor - Sets up the object properties.
+ * Constructor
*
- * Retrieves the userdata and then assigns all of the data keys to direct
- * properties of the object. Calls {@link WP_User::_init_caps()} after
- * setting up the object's user data properties.
+ * Retrieves the userdata and passes it to {@link WP_User::init()}.
*
* @since 2.0.0
* @access public
*
- * @param int|string $id User's ID or username
- * @param int $name Optional. User's username
+ * @param int|string $id User's ID
+ * @param string $name Optional. User's username
* @param int $blog_id Optional Blog ID, defaults to current blog.
* @return WP_User
*/
- function __construct( $id, $name = '', $blog_id = '' ) {
-
- if ( empty( $id ) && empty( $name ) )
- return;
+ function __construct( $id = 0, $name = '', $blog_id = '' ) {
+ if ( ! isset( self::$back_compat_keys ) ) {
+ $prefix = $GLOBALS['wpdb']->prefix;
+ self::$back_compat_keys = array(
+ 'user_firstname' => 'first_name',
+ 'user_lastname' => 'last_name',
+ 'user_description' => 'description',
+ 'user_level' => $prefix . 'user_level',
+ $prefix . 'usersettings' => $prefix . 'user-settings',
+ $prefix . 'usersettingstime' => $prefix . 'user-settings-time',
+ );
+ }
- if ( ! is_numeric( $id ) ) {
+ if ( ! empty( $id ) && ! is_numeric( $id ) ) {
$name = $id;
$id = 0;
}
- if ( ! empty( $id ) )
- $this->data = get_userdata( $id );
+ if ( $id )
+ $data = self::get_data_by( 'id', $id );
else
- $this->data = get_userdatabylogin( $name );
+ $data = self::get_data_by( 'login', $name );
- if ( empty( $this->data->ID ) )
- return;
+ if ( $data )
+ $this->init( $data, $blog_id );
+ }
- foreach ( get_object_vars( $this->data ) as $key => $value ) {
- $this->{$key} = $value;
- }
+ /**
+ * Sets up object properties, including capabilities.
+ *
+ * @param object $data User DB row object
+ * @param int $blog_id Optional. The blog id to initialize for
+ */
+ function init( $data, $blog_id = '' ) {
+ $this->data = $data;
+ $this->ID = (int) $data->ID;
- $this->id = $this->ID;
$this->for_blog( $blog_id );
}
+ /**
+ * Return only the main user fields
+ *
+ * @since 3.3.0
+ *
+ * @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
+ */
+ static function get_data_by( $field, $value ) {
+ global $wpdb;
+
+ if ( 'id' == $field ) {
+ // Make sure the value is numeric to avoid casting objects, for example,
+ // to int 1.
+ if ( ! is_numeric( $value ) )
+ return false;
+ $value = absint( $value );
+ } else {
+ $value = trim( $value );
+ }
+
+ if ( !$value )
+ return false;
+
+ switch ( $field ) {
+ case 'id':
+ $user_id = $value;
+ $db_field = 'ID';
+ break;
+ case 'slug':
+ $user_id = wp_cache_get($value, 'userslugs');
+ $db_field = 'user_nicename';
+ break;
+ case 'email':
+ $user_id = wp_cache_get($value, 'useremail');
+ $db_field = 'user_email';
+ break;
+ case 'login':
+ $value = sanitize_user( $value );
+ $user_id = wp_cache_get($value, 'userlogins');
+ $db_field = 'user_login';
+ break;
+ default:
+ return false;
+ }
+
+ if ( false !== $user_id ) {
+ if ( $user = wp_cache_get( $user_id, 'users' ) )
+ return $user;
+ }
+
+ if ( !$user = $wpdb->get_row( $wpdb->prepare(
+ "SELECT * FROM $wpdb->users WHERE $db_field = %s", $value
+ ) ) )
+ return false;
+
+ update_user_caches( $user );
+
+ return $user;
+ }
+
+ /**
+ * Magic method for checking the existence of a certain custom field
+ *
+ * @since 3.3.0
+ */
+ function __isset( $key ) {
+ if ( 'id' == $key ) {
+ _deprecated_argument( 'WP_User->id', '2.1', __( 'Use <code>WP_User->ID</code> instead.' ) );
+ $key = 'ID';
+ }
+
+ if ( isset( $this->data->$key ) )
+ return true;
+
+ if ( isset( self::$back_compat_keys[ $key ] ) )
+ $key = self::$back_compat_keys[ $key ];
+
+ return metadata_exists( 'user', $this->ID, $key );
+ }
+
+ /**
+ * Magic method for accessing custom fields
+ *
+ * @since 3.3.0
+ */
+ function __get( $key ) {
+ if ( 'id' == $key ) {
+ _deprecated_argument( 'WP_User->id', '2.1', __( 'Use <code>WP_User->ID</code> instead.' ) );
+ return $this->ID;
+ }
+
+ if ( isset( $this->data->$key ) ) {
+ $value = $this->data->$key;
+ } else {
+ if ( isset( self::$back_compat_keys[ $key ] ) )
+ $key = self::$back_compat_keys[ $key ];
+ $value = get_user_meta( $this->ID, $key, true );
+ }
+
+ if ( $this->filter ) {
+ $value = sanitize_user_field( $key, $value, $this->ID, $this->filter );
+ }
+
+ return $value;
+ }
+
+ /**
+ * Magic method for setting custom fields
+ *
+ * @since 3.3.0
+ */
+ function __set( $key, $value ) {
+ if ( 'id' == $key ) {
+ _deprecated_argument( 'WP_User->id', '2.1', __( 'Use <code>WP_User->ID</code> instead.' ) );
+ $this->ID = $value;
+ return;
+ }
+
+ $this->data->$key = $value;
+ }
+
+ /**
+ * Determine whether the user exists in the database.
+ *
+ * @since 3.4.0
+ * @access public
+ *
+ * @return bool True if user exists in the database, false if not.
+ */
+ function exists() {
+ return ! empty( $this->ID );
+ }
+
+ /**
+ * Retrieve the value of a property or meta key.
+ *
+ * Retrieves from the users and usermeta table.
+ *
+ * @since 3.3.0
+ *
+ * @param string $key Property
+ */
+ function get( $key ) {
+ return $this->__get( $key );
+ }
+
+ /**
+ * Determine whether a property or meta key is set
+ *
+ * Consults the users and usermeta tables.
+ *
+ * @since 3.3.0
+ *
+ * @param string $key Property
+ */
+ function has_prop( $key ) {
+ return $this->__isset( $key );
+ }
+
/**
* Set up capability object properties.
*
* property matching the 'cap_key' exists and is an array. If so, it will be
* used.
*
+ * @access protected
* @since 2.1.0
*
* @param string $cap_key Optional capability key
- * @access protected
*/
function _init_caps( $cap_key = '' ) {
global $wpdb;
+
if ( empty($cap_key) )
$this->cap_key = $wpdb->prefix . 'capabilities';
else
$this->cap_key = $cap_key;
- $this->caps = &$this->{$this->cap_key};
+
+ $this->caps = get_user_meta( $this->ID, $this->cap_key, true );
+
if ( ! is_array( $this->caps ) )
$this->caps = array();
+
$this->get_role_caps();
}
//Build $allcaps from role caps, overlay user's $caps
$this->allcaps = array();
foreach ( (array) $this->roles as $role ) {
- $the_role =& $wp_roles->get_role( $role );
+ $the_role = $wp_roles->get_role( $role );
$this->allcaps = array_merge( (array) $this->allcaps, (array) $the_role->capabilities );
}
$this->allcaps = array_merge( (array) $this->allcaps, (array) $this->caps );
*/
function update_user_level_from_caps() {
global $wpdb;
- $this->user_level = array_reduce( array_keys( $this->allcaps ), array( &$this, 'level_reduction' ), 0 );
+ $this->user_level = array_reduce( array_keys( $this->allcaps ), array( $this, 'level_reduction' ), 0 );
update_user_meta( $this->ID, $wpdb->prefix . 'user_level', $this->user_level );
}
*
* This is useful for looking up whether the user has a specific role
* assigned to the user. The second optional parameter can also be used to
- * check for capabilities against a specfic post.
+ * check for capabilities against a specific object, such as a post or user.
*
* @since 2.0.0
* @access public
*
* @param string|int $cap Capability or role name to search.
- * @param int $post_id Optional. Post ID to check capability against specific post.
* @return bool True, if user has capability; false, if user does not have capability.
*/
function has_cap( $cap ) {
$capabilities = apply_filters( 'user_has_cap', $this->allcaps, $caps, $args );
$capabilities['exist'] = true; // Everyone is allowed to exist
foreach ( (array) $caps as $cap ) {
- //echo "Checking cap $cap<br />";
- if ( empty( $capabilities[$cap] ) || !$capabilities[$cap] )
+ if ( empty( $capabilities[ $cap ] ) )
return false;
}
break;
}
- if ( 'private' != $post->post_status ) {
+ $status_obj = get_post_status_object( $post->post_status );
+ if ( $status_obj->public ) {
$caps[] = $post_type->cap->read;
break;
}
if ( is_object( $post_author_data ) && $user_id == $post_author_data->ID )
$caps[] = $post_type->cap->read;
- else
+ elseif ( $status_obj->private )
$caps[] = $post_type->cap->read_private_posts;
+ else
+ $caps = map_meta_cap( 'edit_post', $user_id, $post->ID );
+ break;
+ case 'edit_post_meta':
+ case 'delete_post_meta':
+ case 'add_post_meta':
+ $post = get_post( $args[0] );
+ $post_type_object = get_post_type_object( $post->post_type );
+ $caps = map_meta_cap( $post_type_object->cap->edit_post, $user_id, $post->ID );
+
+ $meta_key = isset( $args[ 1 ] ) ? $args[ 1 ] : false;
+
+ if ( $meta_key && has_filter( "auth_post_meta_{$meta_key}" ) ) {
+ $allowed = apply_filters( "auth_post_meta_{$meta_key}", false, $meta_key, $post->ID, $user_id, $cap, $caps );
+ if ( ! $allowed )
+ $caps[] = $cap;
+ } elseif ( $meta_key && is_protected_meta( $meta_key, 'post' ) ) {
+ $caps[] = $cap;
+ }
break;
case 'edit_comment':
$comment = get_comment( $args[0] );
else
$caps[] = 'do_not_allow';
break;
+ case 'unfiltered_html' :
+ // Disallow unfiltered_html for all users, even admins and super admins.
+ if ( defined( 'DISALLOW_UNFILTERED_HTML' ) && DISALLOW_UNFILTERED_HTML )
+ $caps[] = 'do_not_allow';
+ elseif ( is_multisite() && ! is_super_admin( $user_id ) )
+ $caps[] = $cap;
+ else
+ $caps[] = $cap;
+ break;
case 'edit_files':
case 'edit_plugins':
case 'edit_themes':
break;
}
// Fall through if not DISALLOW_FILE_MODS.
- case 'unfiltered_html':
- // Disallow unfiltered_html for all users, even admins and super admins.
- if ( defined('DISALLOW_UNFILTERED_HTML') && DISALLOW_UNFILTERED_HTML ) {
- $caps[] = 'do_not_allow';
- break;
- }
- // Fall through if not DISALLOW_UNFILTERED_HTML
case 'delete_user':
case 'delete_users':
// If multisite these caps are allowed only for super admins.
$args = array_slice( func_get_args(), 1 );
$args = array_merge( array( $capability ), $args );
- return call_user_func_array( array( &$current_user, 'has_cap' ), $args );
+ return call_user_func_array( array( $current_user, 'has_cap' ), $args );
}
/**
return false;
// Create new object to avoid stomping the global current_user.
- $user = new WP_User( $current_user->id) ;
+ $user = new WP_User( $current_user->ID) ;
- // Set the blog id. @todo add blog id arg to WP_User constructor?
+ // Set the blog id. @todo add blog id arg to WP_User constructor?
$user->for_blog( $blog_id );
$args = array_slice( func_get_args(), 2 );
if ( ! is_object( $user ) )
$user = new WP_User( $user );
- if ( ! $user || ! $user->ID )
+ if ( ! $user || ! $user->exists() )
return false;
$args = array_slice( func_get_args(), 2 );
else
$user = wp_get_current_user();
- if ( empty( $user->id ) )
+ if ( ! $user->exists() )
return false;
if ( is_multisite() ) {
return false;
}
-
-?>