Twenty_Twenty_One_SVG_Icons::get_svg( string $group, string $icon, int $size ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$groupstring

The icon group.

$iconstring

The icon.

$sizeint

The icon-size in pixels.

Return value

string

Performance profile

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

17–35

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

Plugin surface

1 hook

Third-party callbacks on 'twenty_twenty_one_svg_icons_{$group}' run inside this call, and their cost is not bounded by anything here.

Called by

2

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

What it touches

• hookthird-party callbacksapply_filters()called directly

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 Twenty_Twenty_One_SVG_Icons::get_svg() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while Twenty_Twenty_One_SVG_Icons::get_svg() runs, in this order:

1. 1
   apply_filters( twenty_twenty_one_svg_icons_{$group} )filterline 186 (+20 into the body)

   Filters Twenty Twenty-Ones's array of icons.

Uses · 1

• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• Twenty_Twenty_One_SVG_Icons::get_social_link_svg()Detects the social network from a URL and returns the SVG code for its icon.
• twenty_twenty_one_get_icon_svg()Gets the SVG code for a given icon.

Source code

View on Trac ↗View on GitHub ↗

166	public static function get_svg( $group, $icon, $size ) {167 168		if ( 'ui' === $group ) {169			$arr = self::$icons;170		} elseif ( 'social' === $group ) {171			$arr = self::$social_icons;172		} else {173			$arr = array();174		}175 176		/**177		 * Filters Twenty Twenty-Ones's array of icons.178		 *179		 * The dynamic portion of the hook name, `$group`, refers to180		 * the name of the group of icons, either "ui" or "social".181		 *182		 * @since Twenty Twenty-One 1.0183		 *184		 * @param array<string, string> $arr Array of icons.185		 */186		$arr = apply_filters( "twenty_twenty_one_svg_icons_{$group}", $arr );187 188		$svg = '';189		if ( isset( $arr[ $icon ] ) && is_string( $arr[ $icon ] ) ) {190			$repl = sprintf( '<svg class="svg-icon" width="%d" height="%d" aria-hidden="true" role="img" focusable="false" ', $size, $size );191 192			$svg = (string) preg_replace( '/^<svg /', $repl, trim( $arr[ $icon ] ) ); // Add extra attributes to SVG code.193		}194 195		return $svg;196	}

Changelog

Introduced in Twenty Twenty-One 1.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

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

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-content/themes/twentytwentyone/classes/class-twenty-twenty-one-svg-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.