How to add user role management functionality to a WordPress plugin

How to add user role management function to WordPress plug-in

Introduction:
WordPress is one of the most popular content management systems currently and is widely used in various Websites and Blogs. Its plugin system allows users to extend WordPress with custom functionality. In many cases, we need to provide specific user role management capabilities for plugins. This article will guide you on how to add user role management functionality to your plug-in by using the API and sample code provided by WordPress.

Step 1: Create a custom user role
First, we need to create a new user role to add dedicated management permissions to the plug-in. We can use the add_role() function to create a custom role. The following is a sample code that can be used in the activation hook of the plugin:

function custom_plugin_activate() {
    add_role( 'custom_role', 'Custom Role', array(
        // 添加自定义角色的权限
        'read'         => true,
        'edit_posts'   => false,
        'delete_posts' => false,
    ) );
}
register_activation_hook( __FILE__, 'custom_plugin_activate' );

In the above sample code, we use the add_role() function to create a new one named "custom_role" User role, display name is "Custom Role". This custom role has read-only permissions and cannot edit or delete articles.

Step 2: Add a role management page
Next, we need to add a role management page to the plug-in so that administrators can easily assign and revoke roles to users. We can use the add_submenu_page() function to add a submenu page in the WordPress backend and display the user list and role selection box in it. The following is a sample code snippet that can be added to the plugin's initialization function:

function custom_plugin_init() {
    add_submenu_page(
        'options-general.php',
        'Role Management',
        'Role Management',
        'manage_options',
        'custom_plugin_role_management',
        'custom_plugin_role_management_page'
    );
}
add_action( 'admin_menu', 'custom_plugin_init' );

function custom_plugin_role_management_page() {
    if ( ! current_user_can( 'manage_options' ) ) {
        wp_die( 'You do not have sufficient permissions to access this page!' );
    }
    
    // 显示用户列表和角色选择框的代码
}

In the above code, we use the add_submenu_page() function to add a submenu page below the settings menu . In the callback function custom_plugin_role_management_page() of the submenu page, we first check whether the current user has administrative rights through the current_user_can() function. We can then customize the code that displays the user list and role selection box.

Step 3: Assign roles to users
On the role management page, we need to add code to assign roles to users. The following is a sample form that can be added in the custom_plugin_role_management_page() function:

<form method="post" action="">
    <label for="user_id">User:</label>
    <select name="user_id" id="user_id">
        <?php
        $users = get_users();
        foreach ( $users as $user ) {
            echo '<option value="' . $user->ID . '">' . $user->display_name . '</option>';
        }
        ?>
    </select>
    
    <label for="role">Role:</label>
    <select name="role" id="role">
        <?php
        global $wp_roles;
        $roles = $wp_roles->get_names();
        foreach ( $roles as $key => $role ) {
            echo '<option value="' . $key . '">' . $role . '</option>';
        }
        ?>
    </select>
    
    <input type="submit" name="assign_role" value="Assign Role">
</form>

In the above code, we use the get_users() function to get all users, and displayed in the drop-down menu. We also use the global variable $wp_roles to get all roles and display them in the drop-down menu.

Step 4: Process form submission
Finally, we need to process the submission of the role assignment form and assign roles to the user through the wp_update_user() function. The following is an example form handling code that can be added to the custom_plugin_role_management_page() function:

if ( isset( $_POST['assign_role'] ) ) {
    $user_id = $_POST['user_id'];
    $role = $_POST['role'];
    
    $user = new WP_User( $user_id );
    $user->set_role( $role );
}

In the above code, we first check $_POST['assign_role']Exists to determine whether the form is submitted. We then get the user ID and role and assign the role to the user using the WP_User class and the set_role() method.

Conclusion:
Through the above steps, we can add user role management functionality to the WordPress plugin. First, we create a custom user role and add the appropriate permissions to it. Then, we add a role management page and display the user list and role selection box in it. Finally, we handle the form submission and assign roles to the user. This allows administrators to easily manage user roles on the website and achieve more precise permission control.

Reference:

• [WordPress Codex: add_role()](https://developer.wordpress.org/reference/functions/add_role/)
• [WordPress Codex: add_submenu_page()](https://developer.wordpress.org/reference/functions/add_submenu_page/)
• [WordPress Codex: get_users()](https://developer.wordpress.org /reference/functions/get_users/)
• [WordPress Codex: WP_User()](https://developer.wordpress.org/reference/classes/wp_user/)
• [WordPress Codex: wp_update_user()](https://developer.wordpress.org/reference/functions/wp_update_user/)

The above is the detailed content of How to add user role management functionality to a WordPress plugin. For more information, please follow other related articles on the PHP Chinese website!