TwentyTwenty_SVG_Icons::get_svg( string $icon, string $group = 'ui', string $color = '#1A1A1B' )
- Since
- Twenty Twenty 1.0
- Source
wp-content/themes/twentytwenty/classes/class-twentytwenty-svg-icons.php:28
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
$iconstring- Icon name.
$groupstringoptional- Icon group.Default:
'ui' $colorstringoptional- Color.Default:
'#1A1A1B'
Performance profile
How much work a call to TwentyTwenty_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
- 23–41
- Plugin surface
- 2 hooks
- Called by
- 1
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 45.
Third-party callbacks on 'twentytwenty_svg_icons_{$group}', 'twentytwenty_svg_icon_color' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_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 TwentyTwenty_SVG_Icons::get_svg() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 23–41 | apply_filters(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 45 | 23–41 | 3 | |
| 8.5 | 45 | 23–41 | 3 | |
| 8.4 | 45 | 23–41 | 3 | 18 fewer instructions than PHP 8.3 |
| 8.3 | 63 | 23–59 | 3 | |
| 8.2 | 63 | 23–59 | 3 | |
| 8.1 | 63 | 23–59 | 3 | |
| 7.4 | 63 | 23–59 | 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.
Hooks and filters fired · 2
2 hooks fire while TwentyTwenty_SVG_Icons::get_svg() runs, in this order:
- apply_filters( twentytwenty_svg_icons_{$group} )filterline 47 (+19 into the body)
Filters Twenty Twenty's array of icons.
- apply_filters( twentytwenty_svg_icon_color )filterline 58 (+30 into the body)
Filters an SVG icon's color.
Uses · 1
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- twentytwenty_get_theme_svg()Gets information about the SVG icon.
Source code
public static function get_svg( $icon, $group = 'ui', $color = '#1A1A1B' ) { if ( 'ui' === $group ) { $arr = self::$ui_icons; } elseif ( 'social' === $group ) { $arr = self::$social_icons; } else { $arr = array(); } /** * Filters Twenty Twenty's array of icons. * * The dynamic portion of the hook name, `$group`, refers to * the name of the group of icons, either "ui" or "social". * * @since Twenty Twenty 1.5 * * @param array $arr Array of icons. */ $arr = apply_filters( "twentytwenty_svg_icons_{$group}", $arr ); /** * Filters an SVG icon's color. * * @since Twenty Twenty 1.5 * * @param string $color The icon color. * @param string $icon The icon name. * @param string $group The icon group. */ $color = apply_filters( 'twentytwenty_svg_icon_color', $color, $icon, $group ); if ( array_key_exists( $icon, $arr ) ) { $repl = '<svg class="svg-icon" aria-hidden="true" role="img" focusable="false" '; $svg = preg_replace( '/^<svg /', $repl, trim( $arr[ $icon ] ) ); // Add extra attributes to SVG code. $svg = str_replace( '#1A1A1B', $color, $svg ); // Replace the color. $svg = str_replace( '#', '%23', $svg ); // Urlencode hashes. $svg = preg_replace( "/([\n\t]+)/", ' ', $svg ); // Remove newlines & tabs. $svg = preg_replace( '/>\s*</', '><', $svg ); // Remove whitespace between SVG tags. return $svg; } return null; }Changelog
Introduced in Twenty Twenty 1.0. Unchanged from 6.7.7 through 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/classes/class-twentytwenty-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.