WP_Abilities_Registry::unregister( string $name ): WP_Ability|null

Unregisters an ability.

Description

Do not use this method directly. Instead, use the wp_unregister_ability() function.

Parameters

$namestringrequired: The name of the registered ability, with its namespace.

Return

WP_Ability|null The unregistered ability instance on success, null on failure.

Source

public function unregister( string $name ): ?WP_Ability {
	if ( ! $this->is_registered( $name ) ) {
		_doing_it_wrong(
			__METHOD__,
			/* translators: %s: Ability name. */
			sprintf( __( 'Ability "%s" not found.' ), esc_html( $name ) ),
			'6.9.0'
		);
		return null;
	}

	$unregistered_ability = $this->registered_abilities[ $name ];
	unset( $this->registered_abilities[ $name ] );

	return $unregistered_ability;
}

View all references View on Trac View on GitHub

Uses	Description
WP_Abilities_Registry::is_registered()`wp-includes/abilities-api/class-wp-abilities-registry.php`	Checks if an ability is registered.
__()`wp-includes/l10n.php`	Retrieves the translation of $text.
esc_html()`wp-includes/formatting.php`	Escaping for HTML blocks.
_doing_it_wrong()`wp-includes/functions.php`	Marks something as being incorrectly called.

Show 2 more Show less

Changelog

Version	Description
6.9.0	Introduced.

User Contributed Notes

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