WP_Theme_JSON::sanitize_viewport_settings( mixed $viewport_settings ): array
- Since
- 7.1.0
- Source
wp-includes/class-wp-theme-json.php:826
Description
Keeps only supported breakpoint keys, trims valid CSS lengths, and returns the default breakpoints when no valid custom breakpoint is provided. When only one breakpoint is valid, it remains keyed by its configured state and uses a single max-width media query. When tablet is not larger than mobile, it is removed.
Compatibility
- WordPress
- since 7.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 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.
Parameters
$viewport_settingsmixed- Viewport settings from theme.json.
Return value
array- Sanitized viewport breakpoint settings.
Performance profile
How much work a call to WP_Theme_JSON::sanitize_viewport_settings() 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
- 5–32
- 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 60.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
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_Theme_JSON::sanitize_viewport_settings() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_array($viewport_settings) | 5 | none |
is_array($viewport_settings) | 14–32 | array_keys() |
is_array($viewport_settings) && !empty($breakpoints) | 23–24 | array_keys(), key() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 60 | 5–32 | 9 | |
| 8.5 | 60 | 5–32 | 9 | |
| 8.4 | 60 | 5–32 | 9 | 2 fewer instructions than PHP 8.3 |
| 8.3 | 62 | 5–32 | 9 | |
| 8.2 | 62 | 5–32 | 9 | |
| 8.1 | 62 | 5–32 | 9 | |
| 7.4 | 62 | 5–32 | 9 |
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 · 1
- static::get_viewport_breakpoint_value_in_pixels()
Source code
private static function sanitize_viewport_settings( $viewport_settings ) { if ( ! is_array( $viewport_settings ) ) { return static::DEFAULT_VIEWPORT_BREAKPOINTS; } $breakpoints = array(); foreach ( array_keys( static::DEFAULT_VIEWPORT_BREAKPOINTS ) as $breakpoint ) { $value = $viewport_settings[ $breakpoint ] ?? null; $px = static::get_viewport_breakpoint_value_in_pixels( $value ); if ( null !== $px ) { $breakpoints[ $breakpoint ] = array( 'value' => trim( $value ), 'px' => $px, ); } } if ( empty( $breakpoints ) ) { return static::DEFAULT_VIEWPORT_BREAKPOINTS; } if ( 1 === count( $breakpoints ) ) { $breakpoint = key( $breakpoints ); return array( $breakpoint => $breakpoints[ $breakpoint ]['value'] ); } $sanitized = array( 'mobile' => $breakpoints['mobile']['value'] ); if ( isset( $breakpoints['tablet'] ) && $breakpoints['mobile']['px'] < $breakpoints['tablet']['px'] ) { $sanitized['tablet'] = $breakpoints['tablet']['value']; } return $sanitized; }Changelog
Introduced in 7.1.0.
Signature, return type and hooks compared across 1 parsed release.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/class-wp-theme-json.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.