WP_Customize_Header_Image_Setting::sanitize( mixed $value ): array|string|WP_Error|null
- Since
- 7.1.1
- Source
wp-includes/customize/class-wp-customize-header-image-setting.php:103
Description
The value is expected to be one of the following:
- An array of header image data, with the keys
attachment_id,url,thumbnail_url,timestamp,width,height,alt_text, andattachment_parent, as supplied by get_uploaded_header_images(). Any other key is discarded. - An array with a
choicekey, being the legacy format in which any of the other accepted values is nested. - The string
remove-header,random-default-image, orrandom-uploaded-image. - A string corresponding to one of the keys for the array returned by get_uploaded_header_images(), or one of the keys for the array passed into register_default_headers().
Compatibility
- WordPress
- since 7.1.1
- PHP
- 7.4–8.6-dev
- 6.7.10
- 6.8.11
- 6.9.10
- 7.0.7
- 7.1.3
Present in every tracked release (6.7.10 to 7.1.3), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$valuemixed- Value to sanitize.
Return value
array|string|WP_Error|null- Sanitized value, or
null/WP_Errorif invalid. The array holds the header image data, or that data nested under achoicekey, before thecustomize_sanitize_header_image_datafilter, which may return anything, is applied to it.
Performance profile
How much work a call to WP_Customize_Header_Image_Setting::sanitize() 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–24
- Plugin surface
- None
- Called by
- 0
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 36.
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
do_action()one call below WP_Customize_Header_Image_Setting::sanitize()
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_Customize_Header_Image_Setting::sanitize() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10–14 | ->sanitize_choice() |
is_wp_error() | 14–18 | ->sanitize_choice(), is_wp_error() |
!is_wp_error() | 17–24 | ->sanitize_choice(), is_wp_error(), ::sanitize() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 36 instructions, 10–24 executed per call, 6 branches. 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 · 3
- is_wp_error()Checks whether the given variable is a WordPress Error.
- WP_Customize_Header_Image_Setting::sanitize_choice()Sanitizes a header image choice.
- WP_Customize_Setting::sanitize()Sanitize an input.
Source code
public function sanitize( $value ) { /* * The update() method unwraps the legacy `choice` format before handing the value off to * Custom_Image_Header::set_header_image(), so the nested value is what must be sanitized. */ if ( is_array( $value ) && isset( $value['choice'] ) ) { $choice = $this->sanitize_choice( $value['choice'] ); if ( is_null( $choice ) || is_wp_error( $choice ) ) { return $choice; } $value = array( 'choice' => $choice ); } else { $value = $this->sanitize_choice( $value ); if ( is_null( $value ) || is_wp_error( $value ) ) { return $value; } } return parent::sanitize( $value ); }Changelog
Introduced in 7.1.1. Unchanged from 6.7.10 through 7.1.3.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.3 tag, from
src/wp-includes/customize/class-wp-customize-header-image-setting.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.