WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Icons_Registry::unregister()

WP_Icons_Registry::unregister( string $icon_name ): bool

In this article

Back to top

Unregisters an icon.

Parameters

$icon_namestringrequired
Namespaced icon name in the form "collection/icon-name" (e.g. "core/arrow-left").

Return

bool True if the icon was unregistered successfully, false otherwise.

Source

public function unregister( $icon_name ) {
	if ( ! $this->is_registered( $icon_name ) ) {
		_doing_it_wrong(
			__METHOD__,
			sprintf(
				/* translators: %s: Icon name. */
				__( 'Icon "%s" is not registered.' ),
				$icon_name
			),
			'7.1.0'
		);
		return false;
	}

	unset( $this->registered_icons[ $icon_name ] );
	return true;
}

View all references View on Trac View on GitHub

UsesDescription
WP_Icons_Registry::is_registered()wp-includes/class-wp-icons-registry.php

Checks if an icon is registered.

__()wp-includes/l10n.php

Retrieves the translation of $text.

_doing_it_wrong()wp-includes/functions.php

Marks something as being incorrectly called.

Show 1 moreShow less

Changelog

VersionDescription
7.1.0Introduced.

User Contributed Notes

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