WP_Icons_Registry::register( string $icon_name, array $icon_properties ): bool

Compatibility

Present in 2 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. "core/arrow-left").

$icon_propertiesarray

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 with success and false otherwise.

Performance profile

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

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

13–82

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 192.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()one call below WP_Icons_Registry::register()

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 · 10 distinct outcomes

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

Uses · 7

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• WP_Icon_Collections_Registry::get_instance()::is_registered()
• WP_Icon_Collections_Registry::get_instance()Utility method to retrieve the main instance of the class.
• WP_Icons_Registry::sanitize_icon_content()Sanitizes the icon SVG content.
• WP_Icons_Registry::is_registered()Checks if an icon is registered.

Source code

View on Trac ↗View on GitHub ↗

63	public function register( $icon_name, $icon_properties ) {64		if ( ! isset( $icon_name ) || ! is_string( $icon_name ) ) {65			_doing_it_wrong(66				__METHOD__,67				__( 'Icon name must be a string.' ),68				'7.0.0'69			);70			return false;71		}72 73		// Require a namespaced name in the form "collection/icon-name".74		if ( ! str_contains( $icon_name, '/' ) ) {75			_doing_it_wrong(76				__METHOD__,77				__( 'Icon name must be namespaced in the form "collection/icon-name".' ),78				'7.1.0'79			);80			return false;81		}82 83		// Split the namespaced name into a collection slug and an unqualified icon name.84		list( $collection, $unqualified_name ) = explode( '/', $icon_name, 2 );85 86		if ( preg_match( '/[A-Z]/', $unqualified_name ) ) {87			_doing_it_wrong(88				__METHOD__,89				__( 'Icon names must not contain uppercase characters.' ),90				'7.1.0'91			);92			return false;93		}94 95		if ( ! preg_match( '/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?$/', $unqualified_name ) ) {96			_doing_it_wrong(97				__METHOD__,98				__( 'Icon names must start and end with a lowercase letter or digit and contain only lowercase letters, digits, hyphens, and underscores.' ),99				'7.1.0'100			);101			return false;102		}103 104		$allowed_keys = array_fill_keys( array( 'label', 'content', 'file_path' ), 1 );105		foreach ( array_keys( $icon_properties ) as $key ) {106			if ( ! array_key_exists( $key, $allowed_keys ) ) {107				_doing_it_wrong(108					__METHOD__,109					sprintf(110						/* translators: %s: The name of a user-provided key. */111						__( 'Invalid icon property: "%s".' ),112						$key113					),114					'7.0.0'115				);116				return false;117			}118		}119 120		if ( ! WP_Icon_Collections_Registry::get_instance()->is_registered( $collection ) ) {121			_doing_it_wrong(122				__METHOD__,123				sprintf(124					/* translators: %s: Icon collection slug. */125					__( 'Icon collection "%s" is not registered.' ),126					$collection127				),128				'7.1.0'129			);130			return false;131		}132 133		if ( ! isset( $icon_properties['label'] ) || ! is_string( $icon_properties['label'] ) ) {134			_doing_it_wrong(135				__METHOD__,136				__( 'Icon label must be a string.' ),137				'7.0.0'138			);139			return false;140		}141 142		if (

Changelog

Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.

1. 7.0.4
2. 7.1.0

Signature, return type and hooks compared across 2 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 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.