wppaste
WordPress

twentytwenty_get_theme_svg( string $svg_name, string $group = 'ui', string $color = '' )

Since
Twenty Twenty 1.0
Source
wp-content/themes/twentytwenty/inc/svg-icons.php:36
Gets information about the SVG icon.

Compatibility

WordPress
since Twenty Twenty 1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$svg_namestring
The name of the icon.
$groupstringoptional
The group the icon belongs to.Default: 'ui'
$colorstringoptional
Color code.Default: ''

Performance profile

How much work a call to twentytwenty_get_theme_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
15

Executed per call on PHP 8.5. The body compiles to 16.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
6

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

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

WhenInstructionsCalls it makes
always15::TwentyTwenty_SVG_Icons(), wp_kses()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 16 instructions, 15 executed per call, 1 branch. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Used by · 6

Source code

	function twentytwenty_get_theme_svg( $svg_name, $group = 'ui', $color = '' ) { 		// Make sure that only our allowed tags and attributes are included.		$svg = wp_kses(			TwentyTwenty_SVG_Icons::get_svg( $svg_name, $group, $color ),			array(				'svg'     => array(					'class'       => true,					'xmlns'       => true,					'width'       => true,					'height'      => true,					'viewbox'     => true,					'aria-hidden' => true,					'role'        => true,					'focusable'   => true,				),				'path'    => array(					'fill'      => true,					'fill-rule' => true,					'd'         => true,					'transform' => true,				),				'polygon' => array(					'fill'      => true,					'fill-rule' => true,					'points'    => true,					'transform' => true,					'focusable' => true,				),			)		); 		if ( ! $svg ) {			return false;		}		return $svg;	}

Changelog

Introduced in Twenty Twenty 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/twentytwenty/inc/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.