WP_Icons_Registry::__construct()
- Source
wp-includes/class-wp-icons-registry.php:43
Description
WP_Icons_Registry is a singleton class, so keep this protected.
For 7.0, the Icons Registry is closed for third-party icon registry, serving only a subset of core icons.
These icons are defined in @wordpress/packages (Gutenberg repository) as SVG files and as entries in a single manifest file. On init, the registry is loaded with those icons listed in the manifest.
Compatibility
- WordPress
- core
- PHP
- 7.4–8.6-dev
- 6.7.10
- 6.8.11
- 6.9.10
- 7.0.7
- 7.1.3
Present in 2 of the 5 tracked releases, and compiles on PHP 7.4 through 8.6-dev.
Performance profile
How much work a call to WP_Icons_Registry::__construct() 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
- Light
- Scaling
- Scales with input
- Instructions
- 13–28
- Plugin surface
- None
- Called by
- 1
Touches nothing outside its own arguments.
The body loops, so the work grows with how much data it finds.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 57.
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 it touches
- hookthird-party callbacks
do_action()one call below WP_Icons_Registry::__construct()
Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Icons_Registry::__construct() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_readable() && !empty($collection) | 13–14 | is_readable() |
| always | 14–18 | is_readable(), __(), wp_trigger_error() |
is_readable() && !empty($collection) && !$collection | 25–28 | is_readable(), __(), _doing_it_wrong() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 57 instructions, 13–28 executed per call, 6 branches. 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 · 4
- wp_trigger_error()Generates a user-level error/warning/notice/deprecation message.
- __()Retrieves the translation of $text.
- _doing_it_wrong()Marks something as being incorrectly called.
- WP_Icons_Registry::register()Registers an icon.
Used by · 1
- WP_Icons_Registry::get_instance()Utility method to retrieve the main instance of the class.
Source code
protected function __construct() { $icons_directory = __DIR__ . '/images/icon-library/'; $manifest_path = __DIR__ . '/assets/icon-library-manifest.php'; if ( ! is_readable( $manifest_path ) ) { wp_trigger_error( __METHOD__, __( 'Core icon collection manifest is missing or unreadable.' ) ); return; } $collection = include $manifest_path; if ( empty( $collection ) ) { wp_trigger_error( __METHOD__, __( 'Core icon collection manifest is empty or invalid.' ) ); return; } foreach ( $collection as $icon_name => $icon_data ) { if ( empty( $icon_data['filePath'] ) || ! is_string( $icon_data['filePath'] ) ) { _doing_it_wrong( __METHOD__, __( 'Core icon collection manifest must provide valid a "filePath" for each icon.' ), '7.0.0' ); return; } $this->register( 'core/' . $icon_name, array( 'label' => $icon_data['label'], 'filePath' => $icons_directory . $icon_data['filePath'], ) ); } }Changelog
Unchanged from 7.0.7 through 7.1.3.
Signature, return type and hooks compared across 2 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.7 tag, from
src/wp-includes/class-wp-icons-registry.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.