WP_Customize_Media_Control::to_json()
- Since
- 3.4.0, 4.2.0
- Source
wp-includes/customize/class-wp-customize-media-control.php:80
Compatibility
- WordPress
- since 4.2.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.
Performance profile
How much work a call to WP_Customize_Media_Control::to_json() 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
- Heavy
- Scaling
- Constant
- Instructions
- 35–90
- Plugin surface
- None
- Called by
- 1
Reaches the database via get_post().
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 97.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- optionoption read or write
get_option()one call below WP_Customize_Media_Control::to_json() - hookthird-party callbacks
apply_filters()one call below WP_Customize_Media_Control::to_json() - cacheobject cache
wp_cache_get()one call below WP_Customize_Media_Control::to_json() - querycontent query
get_post()one call below WP_Customize_Media_Control::to_json()
Further down the call graph this can also reach serialize 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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Media_Control::to_json() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 35–51 | ::to_json(), get_bloginfo(), html_entity_decode(), current_user_can(), ->value() |
| always | 49–53 | ::to_json(), get_bloginfo(), html_entity_decode(), current_user_can(), ->value(), wp_prepare_attachment_for_js() |
| always | 69–88 | ::to_json(), get_bloginfo(), html_entity_decode(), current_user_can(), ->value(), wp_mime_type_icon(), wp_basename() |
| always | 79–90 | ::to_json(), get_bloginfo(), html_entity_decode(), current_user_can(), ->value(), wp_mime_type_icon(), wp_basename(), wp_prepare_attachment_for_js() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 97 | 35–90 | 8 | |
| 8.5 | 97 | 35–90 | 8 | |
| 8.4 | 97 | 35–90 | 8 | 4 fewer instructions than PHP 8.3 |
| 8.3 | 101 | 35–94 | 8 | |
| 8.2 | 101 | 35–94 | 8 | |
| 8.1 | 101 | 35–94 | 8 | |
| 7.4 | 101 | 35–94 | 8 |
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 · 7
- get_bloginfo()Retrieves information about the current site.
- current_user_can()Returns whether the current user has the specified capability.
- wp_mime_type_icon()Retrieves the icon for a MIME type or attachment.
- wp_basename()i18n-friendly version of basename().
- wp_prepare_attachment_for_js()Prepares an attachment post object for JS, where it is expected to be JSON-encoded and fit into an Attachment model.
- WP_Customize_Control::to_json()Refreshes the parameters passed to the JavaScript via JSON.
- WP_Customize_Media_Control::value()
Used by · 1
- WP_Customize_Upload_Control::to_json()Refresh the parameters passed to the JavaScript via JSON.
Source code
public function to_json() { parent::to_json(); $this->json['label'] = html_entity_decode( $this->label, ENT_QUOTES, get_bloginfo( 'charset' ) ); $this->json['mime_type'] = $this->mime_type; $this->json['button_labels'] = $this->button_labels; $this->json['canUpload'] = current_user_can( 'upload_files' ); $value = $this->value(); if ( is_object( $this->setting ) ) { if ( $this->setting->default ) { /* * Fake an attachment model - needs all fields used by template. * Note that the default value must be a URL, NOT an attachment ID. */ $ext = substr( $this->setting->default, -3 ); $type = in_array( $ext, array( 'jpg', 'png', 'gif', 'bmp', 'webp', 'avif' ), true ) ? 'image' : 'document'; $default_attachment = array( 'id' => 1, 'url' => $this->setting->default, 'type' => $type, 'icon' => wp_mime_type_icon( $type, '.svg' ), 'title' => wp_basename( $this->setting->default ), ); if ( 'image' === $type ) { $default_attachment['sizes'] = array( 'full' => array( 'url' => $this->setting->default ), ); } $this->json['defaultAttachment'] = $default_attachment; } if ( $value && $this->setting->default && $value === $this->setting->default ) { // Set the default as the attachment. $this->json['attachment'] = $this->json['defaultAttachment']; } elseif ( $value ) { $this->json['attachment'] = wp_prepare_attachment_for_js( $value ); } } }Changelog
Introduced in 3.4.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 6.9.7 tag, from
src/wp-includes/customize/class-wp-customize-media-control.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.