get_role( string $role )
Retrieve role object.
Parameters Parameters
- $role
-
(string) (Required) Role name.
Return Return
(WP_Role|null) WP_Role object if found, null if the role does not exist.
Source Source
File: wp-includes/capabilities.php
function get_role( $role ) {
return wp_roles()->get_role( $role );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
Sample Returned Object
WP_Role Object ( [name] => administrator [capabilities] => Array ( [switch_themes] => 1 [edit_themes] => 1 [activate_plugins] => 1 [edit_plugins] => 1 [edit_users] => 1 [edit_files] => 1 [manage_options] => 1 [moderate_comments] => 1 [manage_categories] => 1 [manage_links] => 1 [upload_files] => 1 [import] => 1 [unfiltered_html] => 1 [edit_posts] => 1 [edit_others_posts] => 1 [edit_published_posts] => 1 [publish_posts] => 1 [edit_pages] => 1 [read] => 1 [level_10] => 1 [level_9] => 1 [level_8] => 1 [level_7] => 1 [level_6] => 1 [level_5] => 1 [level_4] => 1 [level_3] => 1 [level_2] => 1 [level_1] => 1 [level_0] => 1 [edit_others_pages] => 1 [edit_published_pages] => 1 [publish_pages] => 1 [delete_pages] => 1 [delete_others_pages] => 1 [delete_published_pages] => 1 [delete_posts] => 1 [delete_others_posts] => 1 [delete_published_posts] => 1 [delete_private_posts] => 1 [edit_private_posts] => 1 [read_private_posts] => 1 [delete_private_pages] => 1 [edit_private_pages] => 1 [read_private_pages] => 1 [delete_users] => 1 [create_users] => 1 [unfiltered_upload] => 1 [edit_dashboard] => 1 [update_plugins] => 1 [delete_plugins] => 1 [install_plugins] => 1 [update_themes] => 1 [install_themes] => 1 [update_core] => 1 [list_users] => 1 [remove_users] => 1 [add_users] => 1 [promote_users] => 1 [edit_theme_options] => 1 [delete_themes] => 1 [export] => 1 [edit_comment] => 1 [approve_comment] => 1 [unapprove_comment] => 1 [reply_comment] => 1 [quick_edit_comment] => 1 [spam_comment] => 1 [unspam_comment] => 1 [trash_comment] => 1 [untrash_comment] => 1 [delete_comment] => 1 [edit_permalink] => 1 ) )Expand full source codeCollapse full source code
Retrieve Admin Role Capabilities.
$admin_role = get_role( 'administrator' )->capabilities; // OutPut Array ( [switch_themes] => 1 [edit_themes] => 1 [activate_plugins] => 1 [edit_plugins] => 1 [edit_users] => 1 [edit_files] => 1 [manage_options] => 1 [moderate_comments] => 1 [manage_categories] => 1 [manage_links] => 1 [upload_files] => 1 [import] => 1 [unfiltered_html] => 1 [edit_posts] => 1 [edit_others_posts] => 1 [edit_published_posts] => 1 [publish_posts] => 1 [edit_pages] => 1 [read] => 1 [level_10] => 1 [level_9] => 1 [level_8] => 1 [level_7] => 1 [level_6] => 1 [level_5] => 1 [level_4] => 1 [level_3] => 1 [level_2] => 1 [level_1] => 1 [level_0] => 1 [edit_others_pages] => 1 [edit_published_pages] => 1 [publish_pages] => 1 [delete_pages] => 1 [delete_others_pages] => 1 [delete_published_pages] => 1 [delete_posts] => 1 [delete_others_posts] => 1 [delete_published_posts] => 1 [delete_private_posts] => 1 [edit_private_posts] => 1 [read_private_posts] => 1 [delete_private_pages] => 1 [edit_private_pages] => 1 [read_private_pages] => 1 [delete_users] => 1 [create_users] => 1 [unfiltered_upload] => 1 [edit_dashboard] => 1 [update_plugins] => 1 [delete_plugins] => 1 [install_plugins] => 1 [update_themes] => 1 [install_themes] => 1 [update_core] => 1 [list_users] => 1 [remove_users] => 1 [promote_users] => 1 [edit_theme_options] => 1 [delete_themes] => 1 [export] => 1 [list_roles] => 1 [create_roles] => 1 [edit_roles] => 1 [delete_roles] => 1 [edit_role_menus] => 1 [edit_posts_role_permissions] => 1 [edit_pages_role_permissions] => 1 [edit_nav_menu_permissions] => 1 [edit_content_shortcodes] => 1 [delete_content_shortcodes] => 1 [edit_login_redirects] => 1 [delete_login_redirects] => 1 [bulk_edit_roles] => 1 [edit_widget_permissions] => 1 [edit_attachments] => 1 [delete_attachments] => 1 [read_others_attachments] => 1 [edit_others_attachments] => 1 [delete_others_attachments] => 1 [edit_users_higher_level] => 1 [delete_users_higher_level] => 1 [promote_users_higher_level] => 1 [promote_users_to_higher_level] => 1 [manage_capabilities] => 1 )Expand full source codeCollapse full source code