WP_Icons_Registry::get_content( string $icon_name ): string|null

Compatibility

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

Parameters

$icon_namestring

Icon name including namespace.

Return value

string|null

The content of the icon, if found.

Performance profile

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

Heavy

Reads or writes the filesystem via is_file().

Scaling

Constant

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

Instructions

9–61

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

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

What it touches

• filesystemfilesystem accessis_file()called directly
• hookthird-party callbacksdo_action()one call below WP_Icons_Registry::get_content()

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

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

Uses · 4

• str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.
• wp_trigger_error()Generates a user-level error/warning/notice/deprecation message.
• __()Retrieves the translation of $text.
• WP_Icons_Registry::sanitize_icon_content()Sanitizes the icon SVG content.

Used by · 2

• WP_Icons_Registry::get_registered_icon()Retrieves an array containing the properties of a registered icon.
• WP_Icons_Registry::get_registered_icons()Retrieves all registered icons.

Source code

View on Trac ↗View on GitHub ↗

276	protected function get_content( $icon_name ) {277		if ( ! isset( $this->registered_icons[ $icon_name ]['content'] ) ) {278			$file_path  = $this->registered_icons[ $icon_name ]['file_path'] ?? '';279			$is_stringy = is_string( $file_path ) || ( is_object( $file_path ) && method_exists( $file_path, '__toString' ) );280			$icon_path  = $is_stringy ? realpath( (string) $file_path ) : false;281 282			if (283				! is_string( $icon_path ) ||284				! str_ends_with( $icon_path, '.svg' ) ||285				! is_file( $icon_path ) ||286				! is_readable( $icon_path )287			) {288				wp_trigger_error(289					__METHOD__,290					__( 'Icon file is missing or unreadable.' )291				);292				return null;293			}294 295			$content = $this->sanitize_icon_content( file_get_contents( $icon_path ) );296 297			if ( empty( $content ) ) {298				wp_trigger_error(299					__METHOD__,300					__( 'Icon content does not contain valid SVG markup.' )301				);302				return null;303			}304 305			$this->registered_icons[ $icon_name ]['content'] = $content;306		}307		return $this->registered_icons[ $icon_name ]['content'];308	}

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.