Codex

Class Reference/WP User

Contents

Description

The WordPress User Class allows accessing properties, roles and capabilities of a specific user.

Usage

To instantiate a specific user, you may use the class constructor : 

<?php $users = new WP_User( $id [, $name [, $blog_id ] ] ); ?>

You can also use the wp_get_current_user global function to get a WP_User object matching the current logged user. 

<?php $current_user = wp_get_current_user(); ?>

Constructor

The WP_User constructor allows the following parameters :

  • id (int) - the user's id. Let empty to use login name instead.
  • name (string) - the user's login name. Ignored if id is set.
  • blog_id (int) - the blog id on a multisite environment. Defaults to the current blog id.

Public Properties

  • ID (int) - the user's ID.
  • caps (array) - the individual capabilities the user has been given.
  • cap_key (string) -
  • roles (array) - the roles the user is part of.
  • allcaps (array) - all capabilities the user has, including individual and role based.
  • first_name (string) - first name of the user.
  • last_name (string) - last name of the user.

Public Methods

get_role_caps()

Retrieve all of the role capabilities and merge with individual capabilities.

All of the capabilities of the roles the user belongs to are merged with the users individual roles. This also means that the user can be denied specific roles that their role might have, but the specific user isn't granted permission to.

Sets the roles and allcaps properties.

Parameters 
None
Returns 
Nothing
Since 
2.0.0

add_role($role)

Add role to user.

Updates the user's meta data option with capabilities and roles.

Parameters 
* role (string) - role name.
Returns 
Nothing
Since 
2.0.0

remove_role($role)

Remove role from user.

Parameters 
* role (string) - role name.
Returns 
Nothing
Since 
2.0.0

set_role($role)

Set the role of the user.

This will remove the previous roles of the user and assign the user the new one. You can set the role to an empty string and it will remove all of the roles from the user.

Parameters 
* role (string) - role name.
Returns 
Nothing
Since 
2.0.0
Related actions 
* set_user_role

add_cap($cap [, $grant ] )

Add capability and grant or deny access to capability.

Parameters 
  • cap (string) - capability name.
  • grant (bool) - whether to grand capability to user. Default to true.
Returns 
Nothing
Since 
2.0.0

remove_cap($cap)

Remove capability from user.

Parameters 
* cap (string) - capability name.
Returns 
Nothing
Since 
2.0.0

remove_all_caps()

Remove all of the capabilities of the user.

Parameters 
None
Returns 
Nothing
Since 
2.1.0

has_cap($cap)

Whether user has capability or role name.

Parameters 
* cap (string) - capability or role name to search.
Returns 
(bool) true if user has capability, false either.
Since 
2.0.0

Examples

Checking if the current user can edit user profiles : 

<?php
    $cu = wp_get_current_user();
    if ($cu->has_cap('edit_users')) {
       // do something
    }    
?>

Change Log

Since 
2.0.0

Source File

WP_User is located in wp-includes/capabilities.php.

Related

External Links

See also index of Class Reference and index of Function Reference.
Retrieved from "http://codex.wordpress.org/Class_Reference/WP_User"

Codex Resources