wpseek.com
A WordPress-centric search engine for devs and theme authors



add_role › WordPress Function

Since
Deprecatedn/a
› add_role ( $role, $display_name, $capabilities = array() )
Parameters: (3)
  • (string) $role Role name.
    Required: Yes
  • (string) $display_name Display name for role.
    Required: Yes
  • (array<string,bool>|array<int,string>) $capabilities Capabilities to be added to the role. Default empty array.
    Required: No
    Default: array()
Returns:
  • (WP_Role|void) WP_Role object, if the role is added.
Defined at:
Codex:
Change Log:
  • 2.0.0

Adds a role, if it does not exist.

The list of capabilities can be passed either as a numerically indexed array of capability names, or an associative array of boolean values keyed by the capability name. To explicitly deny the role a capability, set the value for that capability to false. Examples: // Add a role that can edit posts. add_role( 'custom_role', 'Custom Role', array( 'read', 'edit_posts', ) ); Or, using an associative array: // Add a role that can edit posts but explicitly cannot not delete them. add_role( 'custom_role', 'Custom Role', array( 'read' => true, 'edit_posts' => true, 'delete_posts' => false, ) );


Related Functions: add_filter, wp_roles, get_role, add_feed, add_link

Source 

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

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