WP_Font_Utils::sanitize_font_family( string $font_family ): string
- Since
- 6.5.0
- Source
wp-includes/fonts/class-wp-font-utils.php:60
Description
- Applies
sanitize_text_field. - Adds surrounding quotes to names containing any characters that are not alphabetic or dashes.
It follows the recommendations from the CSS Fonts Module Level 4.
Compatibility
- WordPress
- since 6.5.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
$font_familystring- Font family name(s), comma-separated.
Return value
string- Sanitized and formatted font family name(s).
Performance profile
How much work a call to WP_Font_Utils::sanitize_font_family() 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
- Light
- Scaling
- Scales with input
- Instructions
- 3–19
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
The body loops, so the work grows with what 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.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()one call below WP_Font_Utils::sanitize_font_family()
Further down the call graph this can also reach option, cache, serialize, query 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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Font_Utils::sanitize_font_family() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 3 | none |
!$output | 13 | sanitize_text_field(), ::maybe_add_quotes() |
$output | 18–19 | sanitize_text_field(), explode() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 33 | 3–19 | 5 | |
| 8.5 | 33 | 3–19 | 5 | |
| 8.4 | 33 | 3–19 | 5 | 6 fewer instructions than PHP 8.3 |
| 8.3 | 39 | 3–25 | 5 | |
| 8.2 | 39 | 3–25 | 5 | |
| 8.1 | 39 | 3–25 | 5 | |
| 7.4 | 39 | 3–25 | 5 |
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 · 3
- sanitize_text_field()Sanitizes a string from user input or from the database.
- str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
- WP_Font_Utils::maybe_add_quotes()Adds surrounding quotes to font family names that contain special characters.
Source code
public static function sanitize_font_family( $font_family ) { if ( ! $font_family ) { return ''; } $output = sanitize_text_field( $font_family ); $formatted_items = array(); if ( str_contains( $output, ',' ) ) { $items = explode( ',', $output ); foreach ( $items as $item ) { $formatted_item = self::maybe_add_quotes( $item ); if ( ! empty( $formatted_item ) ) { $formatted_items[] = $formatted_item; } } return implode( ', ', $formatted_items ); } return self::maybe_add_quotes( $output ); }Changelog
Introduced in 6.5.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-includes/fonts/class-wp-font-utils.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.