WP_REST_Icon_Collections_Controller::get_icon_collection( string $slug ): array|WP_Error
- Since
- 7.1.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-icon-collections-controller.php:163
Compatibility
- WordPress
- since 7.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$slugstring- Icon collection slug.
Return value
array|WP_Error- Icon collection data on success, or WP_Error object on failure.
Performance profile
How much work a call to WP_REST_Icon_Collections_Controller::get_icon_collection() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 11–23
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 24.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Icon_Collections_Controller::get_icon_collection() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$collection !== null | 11 | ::WP_Icon_Collections_Registry(), ->get_registered() |
$collection === null | 23 | ::WP_Icon_Collections_Registry(), ->get_registered(), __(), sprintf() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 24 instructions, 11–23 executed per call, 1 branch. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 3
- __()Retrieves the translation of $text.
- WP_Icon_Collections_Registry::get_instance()Utility method to retrieve the main instance of the class.
- WP_Error::__construct()Initializes the error.
Used by · 1
- WP_REST_Icon_Collections_Controller::get_item()Retrieves a specific icon collection.
Source code
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; }Changelog
Introduced in 7.1.0.
Signature, return type and hooks compared across 1 parsed release.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/rest-api/endpoints/class-wp-rest-icon-collections-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.