wp_register_icon( string $icon_name, array $args ): bool

Compatibility

Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$icon_namestring

Namespaced icon name in the form "collection/icon-name" (e.g. "my-plugin/arrow-left"). The "core" collection is reserved for WordPress core icons; third-party code should register icons under its own collection rather than the "core" collection.

$argsarray

List of properties for the icon.

• $labelstring

  Required. A human-readable label for the icon.

• $contentstring

  Optional. SVG markup for the icon. If not provided, the content will be retrieved from the file_path if set. If both content and file_path are not set, the icon will not be registered.

• $file_pathstring

  Optional. The full path to the file containing the icon content.

Return value

bool

True if the icon was registered successfully, else false.

Performance profile

How much work a call to wp_register_icon() 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

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

9

Executed per call on PHP 8.5. The body compiles to 9.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_register_icon() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• WP_Icons_Registry::get_instance()::register()
• WP_Icons_Registry::get_instance()Utility method to retrieve the main instance of the class.

Used by · 1

• _wp_register_default_icons()Registers the default core icons from the manifest.

Source code

View on Trac ↗View on GitHub ↗

61function wp_register_icon( $icon_name, $args ) {62	return WP_Icons_Registry::get_instance()->register( $icon_name, $args );63}

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/icons.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.