WordPress 常用函数 / add_role

简介

添加一个新的用户角色到 WordPress。

用法

<?php add_role( $role, $display_name, $capabilities ); ?>

参数

$role
(string) (required) 用户角色的名称
Default: None

$display_name
(string) (required) 用户角色的显示名
Default: None

$capability
(array) (optional) 权限名称的数组
Default: array()

返回值

(mixed)
成功返回 WP_Role 对象,如果添加的用户角色已存在,返回空。

实例

$result = add_role('basic_contributor', 'Basic Contributor', array(
    'read' => true, // True allows that capability
    'edit_posts' => true,
    'delete_posts' => false, // Use false to explicitly deny
));
if (null !== $result) {
    echo '新的用户角色创建成功!';
} else {
    echo '厄,basic_contributor 这个用户角色已经存在。';
}

注解

新用户角色的设置是添加到数据库中(表 wp_options 的 wp_user_roles 字段中),所以该函数最好在主题/插件激活的时候调用。

修改记录

Since: 2.0.0

源文件

wp-includes/capabilities.php

热门文章