WP_User::add_role │ public │ WP 2.0.0

Adds role to user.

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

Method of the class: WP_User{}

Returns

null. Nothing (null).

Usage

$WP_User = new WP_User();
$WP_User->add_role( $role );

$role(string) (required)

Role name.

Changelog

WP_User::add_role() WP User::add role code ^{WP 6.8.1}

public function add_role( $role ) {
	if ( empty( $role ) ) {
		return;
	}

	if ( in_array( $role, $this->roles, true ) ) {
		return;
	}

	$this->caps[ $role ] = true;
	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 );
}