add_role()

最后更新于：2021-11-25 19:34:06

Add role, if it does not exist.

参数

$role

(string) (Required) Role name.

$display_name

(string) (Required) Display name for role.

$capabilities

(bool[]) (Optional) List of capabilities keyed by the capability name, e.g. array( ‘edit_posts’ => true, ‘delete_posts’ => false ).

Default value: array()

响应

(GC_Role|null) GC_Role object if role is added, null if already exists.

源文件

文件: gc-includes/capabilities.php

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

$result = add_role(
	'guest_author',
	__( 'Guest Author', 'testdomain' ),
    array(
		'read'         => true,  // true allows this capability
		'edit_posts'   => true,
		'delete_posts' => false, // Use false to explicitly deny
    )
);

if ( null !== $result ) {
    echo "Success: {$result->name} user role created.";
}
else {
    echo 'Failure: user role already exists.';
}