TwentyNineteen_SVG_Icons::get_svg( string $group, string $icon, int $size ): string|null
- Source
wp-content/themes/twentynineteen/classes/class-twentynineteen-svg-icons.php:32
Compatibility
- WordPress
- core
- 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
$groupstring- The group of icons ('ui' or 'social').
$iconstring- The specific icon to retrieve.
$sizeint- The desired width and height for the SVG icon.
Return value
string|null- SVG code for the icon, or null if not found.
Performance profile
How much work a call to TwentyNineteen_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
- Scaling
- Constant
- Instructions
- 10–29
- Plugin surface
- None
- Called by
- 3
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 33.
Nothing here hands control to plugin code.
3 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 TwentyNineteen_SVG_Icons::get_svg() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10–29 | none |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 33 | 10–29 | 3 | |
| 8.5 | 33 | 10–29 | 3 | |
| 8.4 | 33 | 10–29 | 3 | 11 fewer instructions than PHP 8.3 |
| 8.3 | 44 | 10–40 | 3 | |
| 8.2 | 44 | 10–40 | 3 | |
| 8.1 | 44 | 10–40 | 3 | |
| 7.4 | 44 | 10–40 | 3 |
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.
Used by · 3
- TwentyNineteen_SVG_Icons::get_social_link_svg()Detects the social network from a URL and returns the SVG code for its icon.
- twentynineteen_get_icon_svg()Gets the SVG code for a given icon.
- twentynineteen_get_social_icon_svg()Gets the SVG code for a given social icon.
Source code
public static function get_svg( $group, $icon, $size ) { if ( 'ui' === $group ) { $arr = self::$ui_icons; } elseif ( 'social' === $group ) { $arr = self::$social_icons; } else { $arr = array(); } if ( array_key_exists( $icon, $arr ) ) { $repl = sprintf( '<svg class="svg-icon" width="%d" height="%d" aria-hidden="true" role="img" focusable="false" ', $size, $size ); $svg = preg_replace( '/^<svg /', $repl, trim( $arr[ $icon ] ) ); // Add extra attributes to SVG code. $svg = preg_replace( "/([\n\t]+)/", ' ', $svg ); // Remove newlines & tabs. $svg = preg_replace( '/>\s*</', '><', $svg ); // Remove whitespace between SVG tags. return $svg; } return null; }Changelog
One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
none to string|null.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-content/themes/twentynineteen/classes/class-twentynineteen-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.