remove_role( string $role )

Removes a role, if it exists.

Contents

Parameters
Source
Related
- Uses
Changelog
User Contributed Notes

Parameters

$role string Required: Role name.

Source

File: wp-includes/capabilities.php. View all references

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

View on Trac View on GitHub

Uses

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

Changelog

Changelog
Version	Description
2.0.0	Introduced.

User Contributed Notes

Skip to note 1 content

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

Contributed by Codex — 8 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.