WordPress.org

remove_role( string $role )

Remove role, if it exists.

Contents

Description
Related
- Uses
User Contributed Notes

Description Description

Parameters Parameters

$role: (string) (Required) Role name.

Source Source

File: wp-includes/capabilities.php

function remove_role( $role ) {
	wp_roles()->remove_role( $role );
}

Expand full source code Collapse full source code View on Trac

Changelog Changelog

Changelog
Version	Description
2.0.0	Introduced.

Uses Uses

Uses
Uses	Description
wp-includes/capabilities.php: wp_roles()	Retrieves the global WP_Roles instance and instantiates it if necessary.
wp-includes/class-wp-roles.php: WP_Roles::remove_role()	Remove role by name.

User Contributed Notes User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Contributed by Codex — 4 years ago
Example
Remove the ‘subscriber’ role if it exists.
```
<?php remove_role( 'subscriber' ); ?>
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.