WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Icons_Controller::get_icon()

WP_REST_Icons_Controller::get_icon( string $name ): array|WP_Error

In this article

Back to top

Retrieves a specific icon from the registry.

Parameters

$namestringrequired
Icon name.

Return

array|WP_Error Icon data on success, or WP_Error object on failure.

Source

public function get_icon( $name ) {
	$registry = WP_Icons_Registry::get_instance();
	$icon     = $registry->get_registered_icon( $name );

	if ( null === $icon ) {
		return new WP_Error(
			'rest_icon_not_found',
			sprintf(
				// translators: %s is the name of any user-provided name
				__( 'Icon not found: "%s".' ),
				$name
			),
			array( 'status' => 404 )
		);
	}

	return $icon;
}

View all references View on Trac View on GitHub

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

Utility method to retrieve the main instance of the class.

__()wp-includes/l10n.php

Retrieves the translation of $text.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 1 moreShow less
Used byDescription
WP_REST_Icons_Controller::get_item()wp-includes/rest-api/endpoints/class-wp-rest-icons-controller.php

Retrieves a specific icon.

User Contributed Notes

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