WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Roles::remove_role()

WP_Roles::remove_role( string $role )

In this article

Back to top

Removes a role by name.

Parameters

$rolestringrequired
Role name.

Source

public function remove_role( $role ) {	if ( ! isset( $this->role_objects[ $role ] ) ) {	return;	}	unset( $this->role_objects[ $role ] );	unset( $this->role_names[ $role ] );	unset( $this->roles[ $role ] );	if ( $this->use_db ) {	update_option( $this->role_key, $this->roles );	}	if ( get_option( 'default_role' ) === $role ) {	update_option( 'default_role', 'subscriber' );	} }

View all references View on Trac View on GitHub

UsesDescription
update_option()wp-includes/option.php

Updates the value of an option that was already added.

get_option()wp-includes/option.php

Retrieves an option value based on an option name.

Used byDescription
remove_role()wp-includes/capabilities.php

Removes a role, if it exists.

Changelog

VersionDescription
2.0.0Introduced.

User Contributed Notes

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