W3cubDocs

/WordPress

add_role( string $role, string $display_name, bool[] $capabilities = array() ): WP_Role|void

Adds a role, if it does not exist.

Parameters

$rolestringrequired
Role name.
$display_namestringrequired
Display name for role.
$capabilitiesbool[]optional
List of capabilities keyed by the capability name, e.g. array( 'edit_posts' => true, 'delete_posts' => false ).

Default:array()

Return

WP_Role|void WP_Role object, if the role is added.

Source

function add_role( $role, $display_name, $capabilities = array() ) {
	if ( empty( $role ) ) {
		return;
	}

	return wp_roles()->add_role( $role, $display_name, $capabilities );
}

Changelog

Version Description
2.0.0 Introduced.

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