WP_Icon_Collections_Registry::register( string $collection_slug, array $collection_properties ): 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

$collection_slugstring

Icon collection slug.

$collection_propertiesarray

List of properties for the icon collection.

• $labelstring

  Required. A human-readable label for the icon collection.

• $descriptionstring

  Optional. A human-readable description for the icon collection.

Return value

bool

True if the collection was registered successfully, false otherwise.

Performance profile

How much work a call to WP_Icon_Collections_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–46

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

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_Icon_Collections_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 · 5 distinct outcomes

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

Uses · 3

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• WP_Icon_Collections_Registry::is_registered()Checks if an icon collection is registered.

Source code

View on Trac ↗View on GitHub ↗

50	public function register( $collection_slug, $collection_properties ) {51		if ( ! isset( $collection_slug ) || ! is_string( $collection_slug ) ) {52			_doing_it_wrong(53				__METHOD__,54				__( 'Icon collection slug must be a string.' ),55				'7.1.0'56			);57			return false;58		}59 60		if ( ! preg_match( '/^[a-z0-9]([a-z0-9_-]*[a-z0-9])?$/', $collection_slug ) ) {61			_doing_it_wrong(62				__METHOD__,63				__( 'Icon collection slug must start and end with a lowercase letter or digit and contain only lowercase letters, digits, hyphens, and underscores.' ),64				'7.1.0'65			);66			return false;67		}68 69		if ( $this->is_registered( $collection_slug ) ) {70			_doing_it_wrong(71				__METHOD__,72				__( 'Icon collection is already registered.' ),73				'7.1.0'74			);75			return false;76		}77 78		if ( ! is_array( $collection_properties ) ) {79			_doing_it_wrong(80				__METHOD__,81				__( 'Icon collection properties must be an array.' ),82				'7.1.0'83			);84			return false;85		}86 87		$allowed_keys = array_fill_keys( array( 'label', 'description' ), 1 );88		foreach ( array_keys( $collection_properties ) as $key ) {89			if ( ! array_key_exists( $key, $allowed_keys ) ) {90				_doing_it_wrong(91					__METHOD__,92					sprintf(93						/* translators: %s: The name of a user-provided key. */94						__( 'Invalid icon collection property: "%s".' ),95						$key96					),97					'7.1.0'98				);99				return false;100			}101		}102 103		if ( ! isset( $collection_properties['label'] ) || ! is_string( $collection_properties['label'] ) ) {104			_doing_it_wrong(105				__METHOD__,106				__( 'Icon collection label must be a string.' ),107				'7.1.0'108			);109			return false;110		}111 112		if ( isset( $collection_properties['description'] ) && ! is_string( $collection_properties['description'] ) ) {113			_doing_it_wrong(114				__METHOD__,115				__( 'Icon collection description must be a string.' ),116				'7.1.0'117			);118			return false;119		}120 121		$defaults = array(122			'description' => '',123		);124 125		$collection = array_merge(126			$defaults,127			$collection_properties,128			array( 'slug' => $collection_slug )129		);

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/class-wp-icon-collections-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.