WP_Customize_Section::json(): array
- Since
- 4.1.0
- Source
wp-includes/class-wp-customize-section.php:237
Compatibility
- WordPress
- since 4.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.
Return value
array- The array to be exported to the client as JSON.
Performance profile
How much work a call to WP_Customize_Section::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
- Moderate
- Scaling
- Constant
- Instructions
- 37–52
- Plugin surface
- None
- Called by
- 3
Reads stored settings via get_option(), cached per request but not free on a cold cache.
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 58.
Nothing here hands control to plugin code.
3 places 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_Section::json() - hookthird-party callbacks
apply_filters()one call below WP_Customize_Section::json()
Further down the call graph this can also reach 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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Section::json() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 37 | wp_array_slice_assoc(), get_bloginfo(), html_entity_decode(), ->get_content(), ->active(), __() |
| always | 52 | wp_array_slice_assoc(), get_bloginfo(), html_entity_decode(), ->get_content(), ->active(), __(), ->get_panel(), esc_html(), sprintf() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 58 | 37–52 | 1 | |
| 8.5 | 58 | 37–52 | 1 | |
| 8.4 | 58 | 37–52 | 1 | |
| 8.3 | 58 | 37–52 | 1 | |
| 8.2 | 58 | 37–52 | 1 | |
| 8.1 | 58 | 37–52 | 1 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 59 | 37–53 | 1 |
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 · 6
- wp_array_slice_assoc()Extracts a slice of an array, given a list of keys.
- get_bloginfo()Retrieves information about the current site.
- __()Retrieves the translation of $text.
- esc_html()Escaping for HTML blocks.
- WP_Customize_Section::get_content()Get the section's content for insertion into the Customizer pane.
- WP_Customize_Section::active()Check whether section is active to current Customizer preview.
Used by · 3
- WP_Customize_Nav_Menu_Section::json()Get section parameters for JS.
- WP_Customize_Sidebar_Section::json()Gather the parameters passed to client JavaScript via JSON.
- WP_Customize_Themes_Section::json()Gets section parameters for JS.
Source code
public function json() { $array = wp_array_slice_assoc( (array) $this, array( 'id', 'description', 'priority', 'panel', 'type', 'description_hidden' ) ); $array['title'] = html_entity_decode( $this->title, ENT_QUOTES, get_bloginfo( 'charset' ) ); $array['content'] = $this->get_content(); $array['active'] = $this->active(); $array['instanceNumber'] = $this->instance_number; if ( $this->panel ) { /* translators: ▸ is the unicode right-pointing triangle. %s: Section title in the Customizer. */ $array['customizeAction'] = sprintf( __( 'Customizing ▸ %s' ), esc_html( $this->manager->get_panel( $this->panel )->title ) ); } else { $array['customizeAction'] = __( 'Customizing' ); } return $array; }Changelog
Introduced in 4.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 6.9.7 tag, from
src/wp-includes/class-wp-customize-section.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.