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

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

bool

True if the icon was registered successfully, else false.

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

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}

History

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.