wp_interactivity_data_wp_context( array $context, string $store_namespace ): string

Generates a 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 ) ); ?>>

Parameters

$contextarrayrequired: The array of context data to encode.
$store_namespacestringoptional: The unique store namespace identifier.

Return

string A complete data-wp-context directive with a JSON encoded value representing the context array and the store namespace if specified.

Source

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 ) ) .
		'\'';
}

View all references View on Trac View on GitHub

Uses	Description
wp_json_encode()`wp-includes/functions.php`	Encodes a variable into JSON, with some confidence checks.

Changelog

Version	Description
6.5.0	Introduced.

User Contributed Notes

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