wppaste
WordPress

wp_interactivity_state( string $store_namespace = null, array $state = array() ): array

Since
6.5.0, 6.6.0
Source
wp-includes/interactivity-api/interactivity-api.php:62
Gets and/or sets the initial state of an Interactivity API store for a given namespace.

Description

If state for that store namespace already exists, it merges the new provided state with the existing one.

The namespace can be omitted inside derived state getters, using the namespace where the getter is defined.

Parameters

$store_namespacestringoptional
The unique store namespace identifier.Default: null
$statearrayoptional
The array that will be merged with the existing state for the specified store namespace.Default: array()

Return value

array
The state for the specified store namespace. This will be the updated state if a $state argument was provided.

Performance profile

How much work a call to wp_interactivity_state() 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

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
10

Executed per call on PHP 8.4. The body compiles to 10.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_interactivity_state() can have, taken from its control-flow graph on PHP 8.4.

WhenInstructionsCalls it makes
always10wp_interactivity(), ->state()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3 and 8.4: 10 instructions, 10 executed per call, 0 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 · 2

  • wp_interactivity()Retrieves the main WP_Interactivity_API instance.
  • wp_interactivity()::state()

Used by · 1

Source code

View on Trac View on GitHub 

function wp_interactivity_state( ?string $store_namespace = null, array $state = array() ): array {	return wp_interactivity()->state( $store_namespace, $state );}

Changelog

Introduced in 6.5.0. One change between 6.7.7 and 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

7.1.0
Parameter $store_namespace retyped from string to string|null.verified against source
6.6.0
The namespace can be omitted when called inside derived state getters.from the docblock
6.5.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 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.