wp_interactivity_data_wp_context( array $context, string $store_namespace = '' ): string
- Since
- 6.5.0
- Source
wp-includes/interactivity-api/interactivity-api.php:104
data-wp-context directive attribute by encoding a context array.Description
This helper function simplifies the creation of data-wp-context directives by providing a way to pass an array of data, which encodes into a JSON string safe for direct use as a HTML attribute value.
Example:
<div <?php echo wp_interactivity_data_wp_context( array( 'isOpen' => true, 'count' => 0 ) ); ?>>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
$contextarray- The array of context data to encode.
$store_namespacestringoptional- The unique store namespace identifier.Default:
''
Return value
string- A complete
data-wp-contextdirective with a JSON encoded value representing the context array and the store namespace if specified.
Performance profile
How much work a call to wp_interactivity_data_wp_context() 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
- 12–16
- Plugin surface
- None
- Called by
- 2
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 19.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
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_interactivity_data_wp_context() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($context) | 12–13 | none |
!empty($context) | 15–16 | wp_json_encode() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 18 | 12–15 | 2 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 19 | 12–16 | 2 | |
| 8.4 | 19 | 12–16 | 2 | |
| 8.3 | 19 | 12–16 | 2 | |
| 8.2 | 19 | 12–16 | 2 | |
| 8.1 | 19 | 12–16 | 2 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 20 | 12–17 | 2 |
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
- wp_json_encode()Encodes a variable into JSON, with some confidence checks.
Used by · 2
- WP_Navigation_Block_Renderer::get_nav_element_directives()Gets the nav element directives.
- render_block_core_search()Dynamically renders the `core/search` block.
Source code
function wp_interactivity_data_wp_context( array $context, string $store_namespace = '' ): string { return 'data-wp-context=\'' . ( $store_namespace ? $store_namespace . '::' : '' ) . ( empty( $context ) ? '{}' : wp_json_encode( $context, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP ) ) . '\'';}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/interactivity-api/interactivity-api.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.