W3cubDocs

/WordPress

WP_User::add_role( string $role )

Add role to user.

Description

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

Parameters

$role

(string) (Required) Role name.

Source

File: wp-includes/class-wp-user.php 

public function add_role( $role ) {
		if ( empty( $role ) ) {
			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 );
	}

Uses

Uses Description
wp-includes/class-wp-user.php: add_user_role

Fires immediately after the user has been given a new role.
wp-includes/class-wp-user.php: WP_User::update_user_level_from_caps()

Update the maximum user level for the user.
wp-includes/class-wp-user.php: WP_User::get_role_caps()

Retrieves all of the capabilities of the user’s roles, and merges them with individual user capabilities.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/user.php: update_user_meta()

Update user meta field based on user ID.

Changelog

Version Description
2.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_user/add_role