WP_REST_Icon_Collections_Controller::get_icon_collection( string $slug ): array|WP_Error

Retrieves a specific icon collection from the registry.

Parameters

$slugstringrequired: Icon collection slug.

Return

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

Source

public function get_icon_collection( $slug ) {
	$registry   = WP_Icon_Collections_Registry::get_instance();
	$collection = $registry->get_registered( $slug );

	if ( null === $collection ) {
		return new WP_Error(
			'rest_icon_collection_not_found',
			sprintf(
				/* translators: %s: Icon collection slug. */
				__( 'Icon collection not found: "%s".' ),
				$slug
			),
			array( 'status' => 404 )
		);
	}

	return $collection;
}

View all references View on Trac View on GitHub

Uses	Description
WP_Icon_Collections_Registry::get_instance()`wp-includes/class-wp-icon-collections-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 more Show less

Used by	Description
WP_REST_Icon_Collections_Controller::get_item()`wp-includes/rest-api/endpoints/class-wp-rest-icon-collections-controller.php`	Retrieves a specific icon collection.

Changelog

Version	Description
7.1.0	Introduced.

User Contributed Notes

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