wp_interactivity_state()WP 6.5.0

Gets and/or sets the initial state of an Interactivity API store for a given namespace.

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.

No Hooks.

Returns

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

Usage

wp_interactivity_state( ?string $store_namespace, $state ): array;
?string $store_namespace **
-
Default: null
$state(array)
The array that will be merged with the existing state for the specified store namespace.
Default: array()

Changelog

Since 6.5.0 Introduced.
Since 6.6.0 The namespace can be omitted when called inside derived state getters.

wp_interactivity_state() code WP 6.8.1

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