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

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

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

Source

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

Changelog

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

User Contributed Notes

You must log in before being able to contribute a note or feedback.