summaryrefslogtreecommitdiffstats
path: root/wp-includes/interactivity-api
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:57:26 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-17 07:57:26 +0000
commit30883c26bdceb9eaf32c8d4a1b0c1bce223b5226 (patch)
tree39a02e2aeb21ab5b7923c6f5757d66d55b708912 /wp-includes/interactivity-api
parentAdding upstream version 6.4.3+dfsg1. (diff)
downloadwordpress-30883c26bdceb9eaf32c8d4a1b0c1bce223b5226.tar.xz
wordpress-30883c26bdceb9eaf32c8d4a1b0c1bce223b5226.zip
Adding upstream version 6.5+dfsg1.upstream/6.5+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'wp-includes/interactivity-api')
-rw-r--r--wp-includes/interactivity-api/class-wp-interactivity-api-directives-processor.php277
-rw-r--r--wp-includes/interactivity-api/class-wp-interactivity-api.php1000
-rw-r--r--wp-includes/interactivity-api/interactivity-api.php170
3 files changed, 1447 insertions, 0 deletions
diff --git a/wp-includes/interactivity-api/class-wp-interactivity-api-directives-processor.php b/wp-includes/interactivity-api/class-wp-interactivity-api-directives-processor.php
new file mode 100644
index 0000000..3b2dcb1
--- /dev/null
+++ b/wp-includes/interactivity-api/class-wp-interactivity-api-directives-processor.php
@@ -0,0 +1,277 @@
+<?php
+/**
+ * Interactivity API: WP_Interactivity_API_Directives_Processor class.
+ *
+ * @package WordPress
+ * @subpackage Interactivity API
+ * @since 6.5.0
+ */
+
+/**
+ * Class used to iterate over the tags of an HTML string and help process the
+ * directive attributes.
+ *
+ * @since 6.5.0
+ *
+ * @access private
+ */
+final class WP_Interactivity_API_Directives_Processor extends WP_HTML_Tag_Processor {
+ /**
+ * List of tags whose closer tag is not visited by the WP_HTML_Tag_Processor.
+ *
+ * @since 6.5.0
+ * @var string[]
+ */
+ const TAGS_THAT_DONT_VISIT_CLOSER_TAG = array(
+ 'SCRIPT',
+ 'IFRAME',
+ 'NOEMBED',
+ 'NOFRAMES',
+ 'STYLE',
+ 'TEXTAREA',
+ 'TITLE',
+ 'XMP',
+ );
+
+ /**
+ * Returns the content between two balanced template tags.
+ *
+ * It positions the cursor in the closer tag of the balanced template tag,
+ * if it exists.
+ *
+ * @since 6.5.0
+ *
+ * @access private
+ *
+ * @return string|null The content between the current opener template tag and its matching closer tag or null if it
+ * doesn't find the matching closing tag or the current tag is not a template opener tag.
+ */
+ public function get_content_between_balanced_template_tags() {
+ if ( 'TEMPLATE' !== $this->get_tag() ) {
+ return null;
+ }
+
+ $positions = $this->get_after_opener_tag_and_before_closer_tag_positions();
+ if ( ! $positions ) {
+ return null;
+ }
+ list( $after_opener_tag, $before_closer_tag ) = $positions;
+
+ return substr( $this->html, $after_opener_tag, $before_closer_tag - $after_opener_tag );
+ }
+
+ /**
+ * Sets the content between two balanced tags.
+ *
+ * @since 6.5.0
+ *
+ * @access private
+ *
+ * @param string $new_content The string to replace the content between the matching tags.
+ * @return bool Whether the content was successfully replaced.
+ */
+ public function set_content_between_balanced_tags( string $new_content ): bool {
+ $positions = $this->get_after_opener_tag_and_before_closer_tag_positions( true );
+ if ( ! $positions ) {
+ return false;
+ }
+ list( $after_opener_tag, $before_closer_tag ) = $positions;
+
+ $this->lexical_updates[] = new WP_HTML_Text_Replacement(
+ $after_opener_tag,
+ $before_closer_tag - $after_opener_tag,
+ esc_html( $new_content )
+ );
+
+ return true;
+ }
+
+ /**
+ * Appends content after the closing tag of a template tag.
+ *
+ * It positions the cursor in the closer tag of the balanced template tag,
+ * if it exists.
+ *
+ * @access private
+ *
+ * @param string $new_content The string to append after the closing template tag.
+ * @return bool Whether the content was successfully appended.
+ */
+ public function append_content_after_template_tag_closer( string $new_content ): bool {
+ if ( empty( $new_content ) || 'TEMPLATE' !== $this->get_tag() || ! $this->is_tag_closer() ) {
+ return false;
+ }
+
+ // Flushes any changes.
+ $this->get_updated_html();
+
+ $bookmark = 'append_content_after_template_tag_closer';
+ $this->set_bookmark( $bookmark );
+ $after_closing_tag = $this->bookmarks[ $bookmark ]->start + $this->bookmarks[ $bookmark ]->length + 1;
+ $this->release_bookmark( $bookmark );
+
+ // Appends the new content.
+ $this->lexical_updates[] = new WP_HTML_Text_Replacement( $after_closing_tag, 0, $new_content );
+
+ return true;
+ }
+
+ /**
+ * Gets the positions right after the opener tag and right before the closer
+ * tag in a balanced tag.
+ *
+ * By default, it positions the cursor in the closer tag of the balanced tag.
+ * If $rewind is true, it seeks back to the opener tag.
+ *
+ * @since 6.5.0
+ *
+ * @access private
+ *
+ * @param bool $rewind Optional. Whether to seek back to the opener tag after finding the positions. Defaults to false.
+ * @return array|null Start and end byte position, or null when no balanced tag bookmarks.
+ */
+ private function get_after_opener_tag_and_before_closer_tag_positions( bool $rewind = false ) {
+ // Flushes any changes.
+ $this->get_updated_html();
+
+ $bookmarks = $this->get_balanced_tag_bookmarks();
+ if ( ! $bookmarks ) {
+ return null;
+ }
+ list( $opener_tag, $closer_tag ) = $bookmarks;
+
+ $after_opener_tag = $this->bookmarks[ $opener_tag ]->start + $this->bookmarks[ $opener_tag ]->length + 1;
+ $before_closer_tag = $this->bookmarks[ $closer_tag ]->start;
+
+ if ( $rewind ) {
+ $this->seek( $opener_tag );
+ }
+
+ $this->release_bookmark( $opener_tag );
+ $this->release_bookmark( $closer_tag );
+
+ return array( $after_opener_tag, $before_closer_tag );
+ }
+
+ /**
+ * Returns a pair of bookmarks for the current opener tag and the matching
+ * closer tag.
+ *
+ * It positions the cursor in the closer tag of the balanced tag, if it
+ * exists.
+ *
+ * @since 6.5.0
+ *
+ * @return array|null A pair of bookmarks, or null if there's no matching closing tag.
+ */
+ private function get_balanced_tag_bookmarks() {
+ static $i = 0;
+ $opener_tag = 'opener_tag_of_balanced_tag_' . ++$i;
+
+ $this->set_bookmark( $opener_tag );
+ if ( ! $this->next_balanced_tag_closer_tag() ) {
+ $this->release_bookmark( $opener_tag );
+ return null;
+ }
+
+ $closer_tag = 'closer_tag_of_balanced_tag_' . ++$i;
+ $this->set_bookmark( $closer_tag );
+
+ return array( $opener_tag, $closer_tag );
+ }
+
+ /**
+ * Skips processing the content between tags.
+ *
+ * It positions the cursor in the closer tag of the foreign element, if it
+ * exists.
+ *
+ * This function is intended to skip processing SVG and MathML inner content
+ * instead of bailing out the whole processing.
+ *
+ * @since 6.5.0
+ *
+ * @access private
+ *
+ * @return bool Whether the foreign content was successfully skipped.
+ */
+ public function skip_to_tag_closer(): bool {
+ $depth = 1;
+ $tag_name = $this->get_tag();
+ while ( $depth > 0 && $this->next_tag(
+ array(
+ 'tag_name' => $tag_name,
+ 'tag_closers' => 'visit',
+ )
+ ) ) {
+ if ( $this->has_self_closing_flag() ) {
+ continue;
+ }
+ $depth += $this->is_tag_closer() ? -1 : 1;
+ }
+
+ return 0 === $depth;
+ }
+
+ /**
+ * Finds the matching closing tag for an opening tag.
+ *
+ * When called while the processor is on an open tag, it traverses the HTML
+ * until it finds the matching closer tag, respecting any in-between content,
+ * including nested tags of the same name. Returns false when called on a
+ * closer tag, a tag that doesn't have a closer tag (void), a tag that
+ * doesn't visit the closer tag, or if no matching closing tag was found.
+ *
+ * @since 6.5.0
+ *
+ * @access private
+ *
+ * @return bool Whether a matching closing tag was found.
+ */
+ public function next_balanced_tag_closer_tag(): bool {
+ $depth = 0;
+ $tag_name = $this->get_tag();
+
+ if ( ! $this->has_and_visits_its_closer_tag() ) {
+ return false;
+ }
+
+ while ( $this->next_tag(
+ array(
+ 'tag_name' => $tag_name,
+ 'tag_closers' => 'visit',
+ )
+ ) ) {
+ if ( ! $this->is_tag_closer() ) {
+ ++$depth;
+ continue;
+ }
+
+ if ( 0 === $depth ) {
+ return true;
+ }
+
+ --$depth;
+ }
+
+ return false;
+ }
+
+ /**
+ * Checks whether the current tag has and will visit its matching closer tag.
+ *
+ * @since 6.5.0
+ *
+ * @access private
+ *
+ * @return bool Whether the current tag has a closer tag.
+ */
+ public function has_and_visits_its_closer_tag(): bool {
+ $tag_name = $this->get_tag();
+
+ return null !== $tag_name && (
+ ! WP_HTML_Processor::is_void( $tag_name ) &&
+ ! in_array( $tag_name, self::TAGS_THAT_DONT_VISIT_CLOSER_TAG, true )
+ );
+ }
+}
diff --git a/wp-includes/interactivity-api/class-wp-interactivity-api.php b/wp-includes/interactivity-api/class-wp-interactivity-api.php
new file mode 100644
index 0000000..3db539a
--- /dev/null
+++ b/wp-includes/interactivity-api/class-wp-interactivity-api.php
@@ -0,0 +1,1000 @@
+<?php
+/**
+ * Interactivity API: WP_Interactivity_API class.
+ *
+ * @package WordPress
+ * @subpackage Interactivity API
+ * @since 6.5.0
+ */
+
+/**
+ * Class used to process the Interactivity API on the server.
+ *
+ * @since 6.5.0
+ */
+final class WP_Interactivity_API {
+ /**
+ * Holds the mapping of directive attribute names to their processor methods.
+ *
+ * @since 6.5.0
+ * @var array
+ */
+ private static $directive_processors = array(
+ 'data-wp-interactive' => 'data_wp_interactive_processor',
+ 'data-wp-router-region' => 'data_wp_router_region_processor',
+ 'data-wp-context' => 'data_wp_context_processor',
+ 'data-wp-bind' => 'data_wp_bind_processor',
+ 'data-wp-class' => 'data_wp_class_processor',
+ 'data-wp-style' => 'data_wp_style_processor',
+ 'data-wp-text' => 'data_wp_text_processor',
+ /*
+ * `data-wp-each` needs to be processed in the last place because it moves
+ * the cursor to the end of the processed items to prevent them to be
+ * processed twice.
+ */
+ 'data-wp-each' => 'data_wp_each_processor',
+ );
+
+ /**
+ * Holds the initial state of the different Interactivity API stores.
+ *
+ * This state is used during the server directive processing. Then, it is
+ * serialized and sent to the client as part of the interactivity data to be
+ * recovered during the hydration of the client interactivity stores.
+ *
+ * @since 6.5.0
+ * @var array
+ */
+ private $state_data = array();
+
+ /**
+ * Holds the configuration required by the different Interactivity API stores.
+ *
+ * This configuration is serialized and sent to the client as part of the
+ * interactivity data and can be accessed by the client interactivity stores.
+ *
+ * @since 6.5.0
+ * @var array
+ */
+ private $config_data = array();
+
+ /**
+ * Flag that indicates whether the `data-wp-router-region` directive has
+ * been found in the HTML and processed.
+ *
+ * The value is saved in a private property of the WP_Interactivity_API
+ * instance instead of using a static variable inside the processor
+ * function, which would hold the same value for all instances
+ * independently of whether they have processed any
+ * `data-wp-router-region` directive or not.
+ *
+ * @since 6.5.0
+ * @var bool
+ */
+ private $has_processed_router_region = false;
+
+ /**
+ * 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.
+ *
+ * @since 6.5.0
+ *
+ * @param string $store_namespace The unique store namespace identifier.
+ * @param array $state Optional. The array that will be merged with the existing state for the specified
+ * store namespace.
+ * @return array The current state for the specified store namespace. This will be the updated state if a $state
+ * argument was provided.
+ */
+ public function state( string $store_namespace, array $state = array() ): array {
+ if ( ! isset( $this->state_data[ $store_namespace ] ) ) {
+ $this->state_data[ $store_namespace ] = array();
+ }
+ if ( is_array( $state ) ) {
+ $this->state_data[ $store_namespace ] = array_replace_recursive(
+ $this->state_data[ $store_namespace ],
+ $state
+ );
+ }
+ return $this->state_data[ $store_namespace ];
+ }
+
+ /**
+ * Gets and/or sets the configuration of the Interactivity API for a given
+ * store namespace.
+ *
+ * If configuration for that store namespace exists, it merges the new
+ * provided configuration with the existing one.
+ *
+ * @since 6.5.0
+ *
+ * @param string $store_namespace The unique store namespace identifier.
+ * @param array $config Optional. The array that will be merged with the existing configuration for the
+ * specified store namespace.
+ * @return array The configuration for the specified store namespace. This will be the updated configuration if a
+ * $config argument was provided.
+ */
+ public function config( string $store_namespace, array $config = array() ): array {
+ if ( ! isset( $this->config_data[ $store_namespace ] ) ) {
+ $this->config_data[ $store_namespace ] = array();
+ }
+ if ( is_array( $config ) ) {
+ $this->config_data[ $store_namespace ] = array_replace_recursive(
+ $this->config_data[ $store_namespace ],
+ $config
+ );
+ }
+ return $this->config_data[ $store_namespace ];
+ }
+
+ /**
+ * Prints the serialized client-side interactivity data.
+ *
+ * Encodes the config and initial state into JSON and prints them inside a
+ * script tag of type "application/json". Once in the browser, the state will
+ * be parsed and used to hydrate the client-side interactivity stores and the
+ * configuration will be available using a `getConfig` utility.
+ *
+ * @since 6.5.0
+ */
+ public function print_client_interactivity_data() {
+ if ( empty( $this->state_data ) && empty( $this->config_data ) ) {
+ return;
+ }
+
+ $interactivity_data = array();
+
+ $config = array();
+ foreach ( $this->config_data as $key => $value ) {
+ if ( ! empty( $value ) ) {
+ $config[ $key ] = $value;
+ }
+ }
+ if ( ! empty( $config ) ) {
+ $interactivity_data['config'] = $config;
+ }
+
+ $state = array();
+ foreach ( $this->state_data as $key => $value ) {
+ if ( ! empty( $value ) ) {
+ $state[ $key ] = $value;
+ }
+ }
+ if ( ! empty( $state ) ) {
+ $interactivity_data['state'] = $state;
+ }
+
+ if ( ! empty( $interactivity_data ) ) {
+ wp_print_inline_script_tag(
+ wp_json_encode(
+ $interactivity_data,
+ JSON_HEX_TAG | JSON_HEX_AMP
+ ),
+ array(
+ 'type' => 'application/json',
+ 'id' => 'wp-interactivity-data',
+ )
+ );
+ }
+ }
+
+ /**
+ * Registers the `@wordpress/interactivity` script modules.
+ *
+ * @since 6.5.0
+ */
+ public function register_script_modules() {
+ $suffix = wp_scripts_get_suffix();
+
+ wp_register_script_module(
+ '@wordpress/interactivity',
+ includes_url( "js/dist/interactivity$suffix.js" )
+ );
+
+ wp_register_script_module(
+ '@wordpress/interactivity-router',
+ includes_url( "js/dist/interactivity-router$suffix.js" ),
+ array( '@wordpress/interactivity' )
+ );
+ }
+
+ /**
+ * Adds the necessary hooks for the Interactivity API.
+ *
+ * @since 6.5.0
+ */
+ public function add_hooks() {
+ add_action( 'wp_enqueue_scripts', array( $this, 'register_script_modules' ) );
+ add_action( 'wp_footer', array( $this, 'print_client_interactivity_data' ) );
+ }
+
+ /**
+ * Processes the interactivity directives contained within the HTML content
+ * and updates the markup accordingly.
+ *
+ * @since 6.5.0
+ *
+ * @param string $html The HTML content to process.
+ * @return string The processed HTML content. It returns the original content when the HTML contains unbalanced tags.
+ */
+ public function process_directives( string $html ): string {
+ if ( ! str_contains( $html, 'data-wp-' ) ) {
+ return $html;
+ }
+
+ $context_stack = array();
+ $namespace_stack = array();
+ $result = $this->process_directives_args( $html, $context_stack, $namespace_stack );
+ return null === $result ? $html : $result;
+ }
+
+ /**
+ * Processes the interactivity directives contained within the HTML content
+ * and updates the markup accordingly.
+ *
+ * It needs the context and namespace stacks to be passed by reference, and
+ * it returns null if the HTML contains unbalanced tags.
+ *
+ * @since 6.5.0
+ *
+ * @param string $html The HTML content to process.
+ * @param array $context_stack The reference to the array used to keep track of contexts during processing.
+ * @param array $namespace_stack The reference to the array used to manage namespaces during processing.
+ * @return string|null The processed HTML content. It returns null when the HTML contains unbalanced tags.
+ */
+ private function process_directives_args( string $html, array &$context_stack, array &$namespace_stack ) {
+ $p = new WP_Interactivity_API_Directives_Processor( $html );
+ $tag_stack = array();
+ $unbalanced = false;
+
+ $directive_processor_prefixes = array_keys( self::$directive_processors );
+ $directive_processor_prefixes_reversed = array_reverse( $directive_processor_prefixes );
+
+ while ( $p->next_tag( array( 'tag_closers' => 'visit' ) ) ) {
+ $tag_name = $p->get_tag();
+
+ /*
+ * Directives inside SVG and MATH tags are not processed,
+ * as they are not compatible with the Tag Processor yet.
+ * We still process the rest of the HTML.
+ */
+ if ( 'SVG' === $tag_name || 'MATH' === $tag_name ) {
+ $p->skip_to_tag_closer();
+ continue;
+ }
+
+ if ( $p->is_tag_closer() ) {
+ list( $opening_tag_name, $directives_prefixes ) = end( $tag_stack );
+
+ if ( 0 === count( $tag_stack ) || $opening_tag_name !== $tag_name ) {
+
+ /*
+ * If the tag stack is empty or the matching opening tag is not the
+ * same than the closing tag, it means the HTML is unbalanced and it
+ * stops processing it.
+ */
+ $unbalanced = true;
+ break;
+ } else {
+ // Remove the last tag from the stack.
+ array_pop( $tag_stack );
+ }
+ } else {
+ if ( 0 !== count( $p->get_attribute_names_with_prefix( 'data-wp-each-child' ) ) ) {
+ /*
+ * If the tag has a `data-wp-each-child` directive, jump to its closer
+ * tag because those tags have already been processed.
+ */
+ $p->next_balanced_tag_closer_tag();
+ continue;
+ } else {
+ $directives_prefixes = array();
+
+ // Checks if there is a server directive processor registered for each directive.
+ foreach ( $p->get_attribute_names_with_prefix( 'data-wp-' ) as $attribute_name ) {
+ list( $directive_prefix ) = $this->extract_prefix_and_suffix( $attribute_name );
+ if ( array_key_exists( $directive_prefix, self::$directive_processors ) ) {
+ $directives_prefixes[] = $directive_prefix;
+ }
+ }
+
+ /*
+ * If this tag will visit its closer tag, it adds it to the tag stack
+ * so it can process its closing tag and check for unbalanced tags.
+ */
+ if ( $p->has_and_visits_its_closer_tag() ) {
+ $tag_stack[] = array( $tag_name, $directives_prefixes );
+ }
+ }
+ }
+ /*
+ * If the matching opener tag didn't have any directives, it can skip the
+ * processing.
+ */
+ if ( 0 === count( $directives_prefixes ) ) {
+ continue;
+ }
+
+ // Directive processing might be different depending on if it is entering the tag or exiting it.
+ $modes = array(
+ 'enter' => ! $p->is_tag_closer(),
+ 'exit' => $p->is_tag_closer() || ! $p->has_and_visits_its_closer_tag(),
+ );
+
+ foreach ( $modes as $mode => $should_run ) {
+ if ( ! $should_run ) {
+ continue;
+ }
+
+ /*
+ * Sorts the attributes by the order of the `directives_processor` array
+ * and checks what directives are present in this element.
+ */
+ $existing_directives_prefixes = array_intersect(
+ 'enter' === $mode ? $directive_processor_prefixes : $directive_processor_prefixes_reversed,
+ $directives_prefixes
+ );
+ foreach ( $existing_directives_prefixes as $directive_prefix ) {
+ $func = is_array( self::$directive_processors[ $directive_prefix ] )
+ ? self::$directive_processors[ $directive_prefix ]
+ : array( $this, self::$directive_processors[ $directive_prefix ] );
+
+ call_user_func_array(
+ $func,
+ array( $p, $mode, &$context_stack, &$namespace_stack, &$tag_stack )
+ );
+ }
+ }
+ }
+
+ /*
+ * It returns null if the HTML is unbalanced because unbalanced HTML is
+ * not safe to process. In that case, the Interactivity API runtime will
+ * update the HTML on the client side during the hydration.
+ */
+ return $unbalanced || 0 < count( $tag_stack ) ? null : $p->get_updated_html();
+ }
+
+ /**
+ * Evaluates the reference path passed to a directive based on the current
+ * store namespace, state and context.
+ *
+ * @since 6.5.0
+ *
+ * @param string|true $directive_value The directive attribute value string or `true` when it's a boolean attribute.
+ * @param string $default_namespace The default namespace to use if none is explicitly defined in the directive
+ * value.
+ * @param array|false $context The current context for evaluating the directive or false if there is no
+ * context.
+ * @return mixed|null The result of the evaluation. Null if the reference path doesn't exist.
+ */
+ private function evaluate( $directive_value, string $default_namespace, $context = false ) {
+ list( $ns, $path ) = $this->extract_directive_value( $directive_value, $default_namespace );
+ if ( empty( $path ) ) {
+ return null;
+ }
+
+ $store = array(
+ 'state' => $this->state_data[ $ns ] ?? array(),
+ 'context' => $context[ $ns ] ?? array(),
+ );
+
+ // Checks if the reference path is preceded by a negation operator (!).
+ $should_negate_value = '!' === $path[0];
+ $path = $should_negate_value ? substr( $path, 1 ) : $path;
+
+ // Extracts the value from the store using the reference path.
+ $path_segments = explode( '.', $path );
+ $current = $store;
+ foreach ( $path_segments as $path_segment ) {
+ if ( isset( $current[ $path_segment ] ) ) {
+ $current = $current[ $path_segment ];
+ } else {
+ return null;
+ }
+ }
+
+ // Returns the opposite if it contains a negation operator (!).
+ return $should_negate_value ? ! $current : $current;
+ }
+
+ /**
+ * Extracts the directive attribute name to separate and return the directive
+ * prefix and an optional suffix.
+ *
+ * The suffix is the string after the first double hyphen and the prefix is
+ * everything that comes before the suffix.
+ *
+ * Example:
+ *
+ * extract_prefix_and_suffix( 'data-wp-interactive' ) => array( 'data-wp-interactive', null )
+ * extract_prefix_and_suffix( 'data-wp-bind--src' ) => array( 'data-wp-bind', 'src' )
+ * extract_prefix_and_suffix( 'data-wp-foo--and--bar' ) => array( 'data-wp-foo', 'and--bar' )
+ *
+ * @since 6.5.0
+ *
+ * @param string $directive_name The directive attribute name.
+ * @return array An array containing the directive prefix and optional suffix.
+ */
+ private function extract_prefix_and_suffix( string $directive_name ): array {
+ return explode( '--', $directive_name, 2 );
+ }
+
+ /**
+ * Parses and extracts the namespace and reference path from the given
+ * directive attribute value.
+ *
+ * If the value doesn't contain an explicit namespace, it returns the
+ * default one. If the value contains a JSON object instead of a reference
+ * path, the function tries to parse it and return the resulting array. If
+ * the value contains strings that represent booleans ("true" and "false"),
+ * numbers ("1" and "1.2") or "null", the function also transform them to
+ * regular booleans, numbers and `null`.
+ *
+ * Example:
+ *
+ * extract_directive_value( 'actions.foo', 'myPlugin' ) => array( 'myPlugin', 'actions.foo' )
+ * extract_directive_value( 'otherPlugin::actions.foo', 'myPlugin' ) => array( 'otherPlugin', 'actions.foo' )
+ * extract_directive_value( '{ "isOpen": false }', 'myPlugin' ) => array( 'myPlugin', array( 'isOpen' => false ) )
+ * extract_directive_value( 'otherPlugin::{ "isOpen": false }', 'myPlugin' ) => array( 'otherPlugin', array( 'isOpen' => false ) )
+ *
+ * @since 6.5.0
+ *
+ * @param string|true $directive_value The directive attribute value. It can be `true` when it's a boolean
+ * attribute.
+ * @param string|null $default_namespace Optional. The default namespace if none is explicitly defined.
+ * @return array An array containing the namespace in the first item and the JSON, the reference path, or null on the
+ * second item.
+ */
+ private function extract_directive_value( $directive_value, $default_namespace = null ): array {
+ if ( empty( $directive_value ) || is_bool( $directive_value ) ) {
+ return array( $default_namespace, null );
+ }
+
+ // Replaces the value and namespace if there is a namespace in the value.
+ if ( 1 === preg_match( '/^([\w\-_\/]+)::./', $directive_value ) ) {
+ list($default_namespace, $directive_value) = explode( '::', $directive_value, 2 );
+ }
+
+ /*
+ * Tries to decode the value as a JSON object. If it fails and the value
+ * isn't `null`, it returns the value as it is. Otherwise, it returns the
+ * decoded JSON or null for the string `null`.
+ */
+ $decoded_json = json_decode( $directive_value, true );
+ if ( null !== $decoded_json || 'null' === $directive_value ) {
+ $directive_value = $decoded_json;
+ }
+
+ return array( $default_namespace, $directive_value );
+ }
+
+ /**
+ * Transforms a kebab-case string to camelCase.
+ *
+ * @param string $str The kebab-case string to transform to camelCase.
+ * @return string The transformed camelCase string.
+ */
+ private function kebab_to_camel_case( string $str ): string {
+ return lcfirst(
+ preg_replace_callback(
+ '/(-)([a-z])/',
+ function ( $matches ) {
+ return strtoupper( $matches[2] );
+ },
+ strtolower( rtrim( $str, '-' ) )
+ )
+ );
+ }
+
+ /**
+ * Processes the `data-wp-interactive` directive.
+ *
+ * It adds the default store namespace defined in the directive value to the
+ * stack so that it's available for the nested interactivity elements.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
+ * @param string $mode Whether the processing is entering or exiting the tag.
+ * @param array $context_stack The reference to the context stack.
+ * @param array $namespace_stack The reference to the store namespace stack.
+ */
+ private function data_wp_interactive_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array &$context_stack, array &$namespace_stack ) {
+ // When exiting tags, it removes the last namespace from the stack.
+ if ( 'exit' === $mode ) {
+ array_pop( $namespace_stack );
+ return;
+ }
+
+ // Tries to decode the `data-wp-interactive` attribute value.
+ $attribute_value = $p->get_attribute( 'data-wp-interactive' );
+
+ /*
+ * Pushes the newly defined namespace or the current one if the
+ * `data-wp-interactive` definition was invalid or does not contain a
+ * namespace. It does so because the function pops out the current namespace
+ * from the stack whenever it finds a `data-wp-interactive`'s closing tag,
+ * independently of whether the previous `data-wp-interactive` definition
+ * contained a valid namespace.
+ */
+ $new_namespace = null;
+ if ( is_string( $attribute_value ) && ! empty( $attribute_value ) ) {
+ $decoded_json = json_decode( $attribute_value, true );
+ if ( is_array( $decoded_json ) ) {
+ $new_namespace = $decoded_json['namespace'] ?? null;
+ } else {
+ $new_namespace = $attribute_value;
+ }
+ }
+ $namespace_stack[] = ( $new_namespace && 1 === preg_match( '/^([\w\-_\/]+)/', $new_namespace ) )
+ ? $new_namespace
+ : end( $namespace_stack );
+ }
+
+ /**
+ * Processes the `data-wp-context` directive.
+ *
+ * It adds the context defined in the directive value to the stack so that
+ * it's available for the nested interactivity elements.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
+ * @param string $mode Whether the processing is entering or exiting the tag.
+ * @param array $context_stack The reference to the context stack.
+ * @param array $namespace_stack The reference to the store namespace stack.
+ */
+ private function data_wp_context_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array &$context_stack, array &$namespace_stack ) {
+ // When exiting tags, it removes the last context from the stack.
+ if ( 'exit' === $mode ) {
+ array_pop( $context_stack );
+ return;
+ }
+
+ $attribute_value = $p->get_attribute( 'data-wp-context' );
+ $namespace_value = end( $namespace_stack );
+
+ // Separates the namespace from the context JSON object.
+ list( $namespace_value, $decoded_json ) = is_string( $attribute_value ) && ! empty( $attribute_value )
+ ? $this->extract_directive_value( $attribute_value, $namespace_value )
+ : array( $namespace_value, null );
+
+ /*
+ * If there is a namespace, it adds a new context to the stack merging the
+ * previous context with the new one.
+ */
+ if ( is_string( $namespace_value ) ) {
+ $context_stack[] = array_replace_recursive(
+ end( $context_stack ) !== false ? end( $context_stack ) : array(),
+ array( $namespace_value => is_array( $decoded_json ) ? $decoded_json : array() )
+ );
+ } else {
+ /*
+ * If there is no namespace, it pushes the current context to the stack.
+ * It needs to do so because the function pops out the current context
+ * from the stack whenever it finds a `data-wp-context`'s closing tag.
+ */
+ $context_stack[] = end( $context_stack );
+ }
+ }
+
+ /**
+ * Processes the `data-wp-bind` directive.
+ *
+ * It updates or removes the bound attributes based on the evaluation of its
+ * associated reference.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
+ * @param string $mode Whether the processing is entering or exiting the tag.
+ * @param array $context_stack The reference to the context stack.
+ * @param array $namespace_stack The reference to the store namespace stack.
+ */
+ private function data_wp_bind_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array &$context_stack, array &$namespace_stack ) {
+ if ( 'enter' === $mode ) {
+ $all_bind_directives = $p->get_attribute_names_with_prefix( 'data-wp-bind--' );
+
+ foreach ( $all_bind_directives as $attribute_name ) {
+ list( , $bound_attribute ) = $this->extract_prefix_and_suffix( $attribute_name );
+ if ( empty( $bound_attribute ) ) {
+ return;
+ }
+
+ $attribute_value = $p->get_attribute( $attribute_name );
+ $result = $this->evaluate( $attribute_value, end( $namespace_stack ), end( $context_stack ) );
+
+ if (
+ null !== $result &&
+ (
+ false !== $result ||
+ ( strlen( $bound_attribute ) > 5 && '-' === $bound_attribute[4] )
+ )
+ ) {
+ /*
+ * If the result of the evaluation is a boolean and the attribute is
+ * `aria-` or `data-, convert it to a string "true" or "false". It
+ * follows the exact same logic as Preact because it needs to
+ * replicate what Preact will later do in the client:
+ * https://github.com/preactjs/preact/blob/ea49f7a0f9d1ff2c98c0bdd66aa0cbc583055246/src/diff/props.js#L131C24-L136
+ */
+ if (
+ is_bool( $result ) &&
+ ( strlen( $bound_attribute ) > 5 && '-' === $bound_attribute[4] )
+ ) {
+ $result = $result ? 'true' : 'false';
+ }
+ $p->set_attribute( $bound_attribute, $result );
+ } else {
+ $p->remove_attribute( $bound_attribute );
+ }
+ }
+ }
+ }
+
+ /**
+ * Processes the `data-wp-class` directive.
+ *
+ * It adds or removes CSS classes in the current HTML element based on the
+ * evaluation of its associated references.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
+ * @param string $mode Whether the processing is entering or exiting the tag.
+ * @param array $context_stack The reference to the context stack.
+ * @param array $namespace_stack The reference to the store namespace stack.
+ */
+ private function data_wp_class_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array &$context_stack, array &$namespace_stack ) {
+ if ( 'enter' === $mode ) {
+ $all_class_directives = $p->get_attribute_names_with_prefix( 'data-wp-class--' );
+
+ foreach ( $all_class_directives as $attribute_name ) {
+ list( , $class_name ) = $this->extract_prefix_and_suffix( $attribute_name );
+ if ( empty( $class_name ) ) {
+ return;
+ }
+
+ $attribute_value = $p->get_attribute( $attribute_name );
+ $result = $this->evaluate( $attribute_value, end( $namespace_stack ), end( $context_stack ) );
+
+ if ( $result ) {
+ $p->add_class( $class_name );
+ } else {
+ $p->remove_class( $class_name );
+ }
+ }
+ }
+ }
+
+ /**
+ * Processes the `data-wp-style` directive.
+ *
+ * It updates the style attribute value of the current HTML element based on
+ * the evaluation of its associated references.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
+ * @param string $mode Whether the processing is entering or exiting the tag.
+ * @param array $context_stack The reference to the context stack.
+ * @param array $namespace_stack The reference to the store namespace stack.
+ */
+ private function data_wp_style_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array &$context_stack, array &$namespace_stack ) {
+ if ( 'enter' === $mode ) {
+ $all_style_attributes = $p->get_attribute_names_with_prefix( 'data-wp-style--' );
+
+ foreach ( $all_style_attributes as $attribute_name ) {
+ list( , $style_property ) = $this->extract_prefix_and_suffix( $attribute_name );
+ if ( empty( $style_property ) ) {
+ continue;
+ }
+
+ $directive_attribute_value = $p->get_attribute( $attribute_name );
+ $style_property_value = $this->evaluate( $directive_attribute_value, end( $namespace_stack ), end( $context_stack ) );
+ $style_attribute_value = $p->get_attribute( 'style' );
+ $style_attribute_value = ( $style_attribute_value && ! is_bool( $style_attribute_value ) ) ? $style_attribute_value : '';
+
+ /*
+ * Checks first if the style property is not falsy and the style
+ * attribute value is not empty because if it is, it doesn't need to
+ * update the attribute value.
+ */
+ if ( $style_property_value || $style_attribute_value ) {
+ $style_attribute_value = $this->merge_style_property( $style_attribute_value, $style_property, $style_property_value );
+ /*
+ * If the style attribute value is not empty, it sets it. Otherwise,
+ * it removes it.
+ */
+ if ( ! empty( $style_attribute_value ) ) {
+ $p->set_attribute( 'style', $style_attribute_value );
+ } else {
+ $p->remove_attribute( 'style' );
+ }
+ }
+ }
+ }
+ }
+
+ /**
+ * Merges an individual style property in the `style` attribute of an HTML
+ * element, updating or removing the property when necessary.
+ *
+ * If a property is modified, the old one is removed and the new one is added
+ * at the end of the list.
+ *
+ * @since 6.5.0
+ *
+ * Example:
+ *
+ * merge_style_property( 'color:green;', 'color', 'red' ) => 'color:red;'
+ * merge_style_property( 'background:green;', 'color', 'red' ) => 'background:green;color:red;'
+ * merge_style_property( 'color:green;', 'color', null ) => ''
+ *
+ * @param string $style_attribute_value The current style attribute value.
+ * @param string $style_property_name The style property name to set.
+ * @param string|false|null $style_property_value The value to set for the style property. With false, null or an
+ * empty string, it removes the style property.
+ * @return string The new style attribute value after the specified property has been added, updated or removed.
+ */
+ private function merge_style_property( string $style_attribute_value, string $style_property_name, $style_property_value ): string {
+ $style_assignments = explode( ';', $style_attribute_value );
+ $result = array();
+ $style_property_value = ! empty( $style_property_value ) ? rtrim( trim( $style_property_value ), ';' ) : null;
+ $new_style_property = $style_property_value ? $style_property_name . ':' . $style_property_value . ';' : '';
+
+ // Generates an array with all the properties but the modified one.
+ foreach ( $style_assignments as $style_assignment ) {
+ if ( empty( trim( $style_assignment ) ) ) {
+ continue;
+ }
+ list( $name, $value ) = explode( ':', $style_assignment );
+ if ( trim( $name ) !== $style_property_name ) {
+ $result[] = trim( $name ) . ':' . trim( $value ) . ';';
+ }
+ }
+
+ // Adds the new/modified property at the end of the list.
+ $result[] = $new_style_property;
+
+ return implode( '', $result );
+ }
+
+ /**
+ * Processes the `data-wp-text` directive.
+ *
+ * It updates the inner content of the current HTML element based on the
+ * evaluation of its associated reference.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
+ * @param string $mode Whether the processing is entering or exiting the tag.
+ * @param array $context_stack The reference to the context stack.
+ * @param array $namespace_stack The reference to the store namespace stack.
+ */
+ private function data_wp_text_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array &$context_stack, array &$namespace_stack ) {
+ if ( 'enter' === $mode ) {
+ $attribute_value = $p->get_attribute( 'data-wp-text' );
+ $result = $this->evaluate( $attribute_value, end( $namespace_stack ), end( $context_stack ) );
+
+ /*
+ * Follows the same logic as Preact in the client and only changes the
+ * content if the value is a string or a number. Otherwise, it removes the
+ * content.
+ */
+ if ( is_string( $result ) || is_numeric( $result ) ) {
+ $p->set_content_between_balanced_tags( esc_html( $result ) );
+ } else {
+ $p->set_content_between_balanced_tags( '' );
+ }
+ }
+ }
+
+ /**
+ * Returns the CSS styles for animating the top loading bar in the router.
+ *
+ * @since 6.5.0
+ *
+ * @return string The CSS styles for the router's top loading bar animation.
+ */
+ private function get_router_animation_styles(): string {
+ return <<<CSS
+ .wp-interactivity-router-loading-bar {
+ position: fixed;
+ top: 0;
+ left: 0;
+ margin: 0;
+ padding: 0;
+ width: 100vw;
+ max-width: 100vw !important;
+ height: 4px;
+ background-color: #000;
+ opacity: 0
+ }
+ .wp-interactivity-router-loading-bar.start-animation {
+ animation: wp-interactivity-router-loading-bar-start-animation 30s cubic-bezier(0.03, 0.5, 0, 1) forwards
+ }
+ .wp-interactivity-router-loading-bar.finish-animation {
+ animation: wp-interactivity-router-loading-bar-finish-animation 300ms ease-in
+ }
+ @keyframes wp-interactivity-router-loading-bar-start-animation {
+ 0% { transform: scaleX(0); transform-origin: 0 0; opacity: 1 }
+ 100% { transform: scaleX(1); transform-origin: 0 0; opacity: 1 }
+ }
+ @keyframes wp-interactivity-router-loading-bar-finish-animation {
+ 0% { opacity: 1 }
+ 50% { opacity: 1 }
+ 100% { opacity: 0 }
+ }
+CSS;
+ }
+
+ /**
+ * Outputs the markup for the top loading indicator and the screen reader
+ * notifications during client-side navigations.
+ *
+ * This method prints a div element representing a loading bar visible during
+ * navigation, as well as an aria-live region that can be read by screen
+ * readers to announce navigation status.
+ *
+ * @since 6.5.0
+ */
+ public function print_router_loading_and_screen_reader_markup() {
+ echo <<<HTML
+ <div
+ class="wp-interactivity-router-loading-bar"
+ data-wp-interactive="core/router"
+ data-wp-class--start-animation="state.navigation.hasStarted"
+ data-wp-class--finish-animation="state.navigation.hasFinished"
+ ></div>
+ <div
+ class="screen-reader-text"
+ aria-live="polite"
+ data-wp-interactive="core/router"
+ data-wp-text="state.navigation.message"
+ ></div>
+HTML;
+ }
+
+ /**
+ * Processes the `data-wp-router-region` directive.
+ *
+ * It renders in the footer a set of HTML elements to notify users about
+ * client-side navigations. More concretely, the elements added are 1) a
+ * top loading bar to visually inform that a navigation is in progress
+ * and 2) an `aria-live` region for accessible navigation announcements.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
+ * @param string $mode Whether the processing is entering or exiting the tag.
+ */
+ private function data_wp_router_region_processor( WP_Interactivity_API_Directives_Processor $p, string $mode ) {
+ if ( 'enter' === $mode && ! $this->has_processed_router_region ) {
+ $this->has_processed_router_region = true;
+
+ // Initialize the `core/router` store.
+ $this->state(
+ 'core/router',
+ array(
+ 'navigation' => array(
+ 'texts' => array(
+ 'loading' => __( 'Loading page, please wait.' ),
+ 'loaded' => __( 'Page Loaded.' ),
+ ),
+ ),
+ )
+ );
+
+ // Enqueues as an inline style.
+ wp_register_style( 'wp-interactivity-router-animations', false );
+ wp_add_inline_style( 'wp-interactivity-router-animations', $this->get_router_animation_styles() );
+ wp_enqueue_style( 'wp-interactivity-router-animations' );
+
+ // Adds the necessary markup to the footer.
+ add_action( 'wp_footer', array( $this, 'print_router_loading_and_screen_reader_markup' ) );
+ }
+ }
+
+ /**
+ * Processes the `data-wp-each` directive.
+ *
+ * This directive gets an array passed as reference and iterates over it
+ * generating new content for each item based on the inner markup of the
+ * `template` tag.
+ *
+ * @since 6.5.0
+ *
+ * @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
+ * @param string $mode Whether the processing is entering or exiting the tag.
+ * @param array $context_stack The reference to the context stack.
+ * @param array $namespace_stack The reference to the store namespace stack.
+ * @param array $tag_stack The reference to the tag stack.
+ */
+ private function data_wp_each_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array &$context_stack, array &$namespace_stack, array &$tag_stack ) {
+ if ( 'enter' === $mode && 'TEMPLATE' === $p->get_tag() ) {
+ $attribute_name = $p->get_attribute_names_with_prefix( 'data-wp-each' )[0];
+ $extracted_suffix = $this->extract_prefix_and_suffix( $attribute_name );
+ $item_name = isset( $extracted_suffix[1] ) ? $this->kebab_to_camel_case( $extracted_suffix[1] ) : 'item';
+ $attribute_value = $p->get_attribute( $attribute_name );
+ $result = $this->evaluate( $attribute_value, end( $namespace_stack ), end( $context_stack ) );
+
+ // Gets the content between the template tags and leaves the cursor in the closer tag.
+ $inner_content = $p->get_content_between_balanced_template_tags();
+
+ // Checks if there is a manual server-side directive processing.
+ $template_end = 'data-wp-each: template end';
+ $p->set_bookmark( $template_end );
+ $p->next_tag();
+ $manual_sdp = $p->get_attribute( 'data-wp-each-child' );
+ $p->seek( $template_end ); // Rewinds to the template closer tag.
+ $p->release_bookmark( $template_end );
+
+ /*
+ * It doesn't process in these situations:
+ * - Manual server-side directive processing.
+ * - Empty or non-array values.
+ * - Associative arrays because those are deserialized as objects in JS.
+ * - Templates that contain top-level texts because those texts can't be
+ * identified and removed in the client.
+ */
+ if (
+ $manual_sdp ||
+ empty( $result ) ||
+ ! is_array( $result ) ||
+ ! array_is_list( $result ) ||
+ ! str_starts_with( trim( $inner_content ), '<' ) ||
+ ! str_ends_with( trim( $inner_content ), '>' )
+ ) {
+ array_pop( $tag_stack );
+ return;
+ }
+
+ // Extracts the namespace from the directive attribute value.
+ $namespace_value = end( $namespace_stack );
+ list( $namespace_value ) = is_string( $attribute_value ) && ! empty( $attribute_value )
+ ? $this->extract_directive_value( $attribute_value, $namespace_value )
+ : array( $namespace_value, null );
+
+ // Processes the inner content for each item of the array.
+ $processed_content = '';
+ foreach ( $result as $item ) {
+ // Creates a new context that includes the current item of the array.
+ $context_stack[] = array_replace_recursive(
+ end( $context_stack ) !== false ? end( $context_stack ) : array(),
+ array( $namespace_value => array( $item_name => $item ) )
+ );
+
+ // Processes the inner content with the new context.
+ $processed_item = $this->process_directives_args( $inner_content, $context_stack, $namespace_stack );
+
+ if ( null === $processed_item ) {
+ // If the HTML is unbalanced, stop processing it.
+ array_pop( $context_stack );
+ return;
+ }
+
+ // Adds the `data-wp-each-child` to each top-level tag.
+ $i = new WP_Interactivity_API_Directives_Processor( $processed_item );
+ while ( $i->next_tag() ) {
+ $i->set_attribute( 'data-wp-each-child', true );
+ $i->next_balanced_tag_closer_tag();
+ }
+ $processed_content .= $i->get_updated_html();
+
+ // Removes the current context from the stack.
+ array_pop( $context_stack );
+ }
+
+ // Appends the processed content after the tag closer of the template.
+ $p->append_content_after_template_tag_closer( $processed_content );
+
+ // Pops the last tag because it skipped the closing tag of the template tag.
+ array_pop( $tag_stack );
+ }
+ }
+}
diff --git a/wp-includes/interactivity-api/interactivity-api.php b/wp-includes/interactivity-api/interactivity-api.php
new file mode 100644
index 0000000..b8f3e50
--- /dev/null
+++ b/wp-includes/interactivity-api/interactivity-api.php
@@ -0,0 +1,170 @@
+<?php
+/**
+ * Interactivity API: Functions and hooks
+ *
+ * @package WordPress
+ * @subpackage Interactivity API
+ * @since 6.5.0
+ */
+
+/**
+ * Processes the directives on the rendered HTML of the interactive blocks.
+ *
+ * This processes only one root interactive block at a time because the
+ * rendered HTML of that block contains the rendered HTML of all its inner
+ * blocks, including any interactive block. It does so by ignoring all the
+ * interactive inner blocks until the root interactive block is processed.
+ *
+ * @since 6.5.0
+ *
+ * @param array $parsed_block The parsed block.
+ * @return array The same parsed block.
+ */
+function wp_interactivity_process_directives_of_interactive_blocks( array $parsed_block ): array {
+ static $root_interactive_block = null;
+
+ /*
+ * Checks whether a root interactive block is already annotated for
+ * processing, and if it is, it ignores the subsequent ones.
+ */
+ if ( null === $root_interactive_block ) {
+ $block_name = $parsed_block['blockName'];
+ $block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block_name );
+
+ if (
+ isset( $block_name ) &&
+ ( ( isset( $block_type->supports['interactivity'] ) && true === $block_type->supports['interactivity'] ) ||
+ ( isset( $block_type->supports['interactivity']['interactive'] ) && true === $block_type->supports['interactivity']['interactive'] ) )
+ ) {
+ // Annotates the root interactive block for processing.
+ $root_interactive_block = array( $block_name, $parsed_block );
+
+ /*
+ * Adds a filter to process the root interactive block once it has
+ * finished rendering.
+ */
+ $process_interactive_blocks = static function ( string $content, array $parsed_block ) use ( &$root_interactive_block, &$process_interactive_blocks ): string {
+ // Checks whether the current block is the root interactive block.
+ list($root_block_name, $root_parsed_block) = $root_interactive_block;
+ if ( $root_block_name === $parsed_block['blockName'] && $parsed_block === $root_parsed_block ) {
+ // The root interactive blocks has finished rendering, process it.
+ $content = wp_interactivity_process_directives( $content );
+ // Removes the filter and reset the root interactive block.
+ remove_filter( 'render_block_' . $parsed_block['blockName'], $process_interactive_blocks );
+ $root_interactive_block = null;
+ }
+ return $content;
+ };
+
+ /*
+ * Uses a priority of 100 to ensure that other filters can add additional
+ * directives before the processing starts.
+ */
+ add_filter( 'render_block_' . $block_name, $process_interactive_blocks, 100, 2 );
+ }
+ }
+
+ return $parsed_block;
+}
+/*
+ * Uses a priority of 100 to ensure that other filters can add additional attributes to
+ * $parsed_block before the processing starts.
+ */
+add_filter( 'render_block_data', 'wp_interactivity_process_directives_of_interactive_blocks', 100, 1 );
+
+/**
+ * Retrieves the main WP_Interactivity_API instance.
+ *
+ * It provides access to the WP_Interactivity_API instance, creating one if it
+ * doesn't exist yet.
+ *
+ * @since 6.5.0
+ *
+ * @global WP_Interactivity_API $wp_interactivity
+ *
+ * @return WP_Interactivity_API The main WP_Interactivity_API instance.
+ */
+function wp_interactivity(): WP_Interactivity_API {
+ global $wp_interactivity;
+ if ( ! ( $wp_interactivity instanceof WP_Interactivity_API ) ) {
+ $wp_interactivity = new WP_Interactivity_API();
+ }
+ return $wp_interactivity;
+}
+
+/**
+ * Processes the interactivity directives contained within the HTML content
+ * and updates the markup accordingly.
+ *
+ * @since 6.5.0
+ *
+ * @param string $html The HTML content to process.
+ * @return string The processed HTML content. It returns the original content when the HTML contains unbalanced tags.
+ */
+function wp_interactivity_process_directives( string $html ): string {
+ return wp_interactivity()->process_directives( $html );
+}
+
+/**
+ * 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.
+ *
+ * @since 6.5.0
+ *
+ * @param string $store_namespace The unique store namespace identifier.
+ * @param array $state Optional. The array that will be merged with the existing state for the specified
+ * store namespace.
+ * @return array The state for the specified store namespace. This will be the updated state if a $state argument was
+ * provided.
+ */
+function wp_interactivity_state( string $store_namespace, array $state = array() ): array {
+ return wp_interactivity()->state( $store_namespace, $state );
+}
+
+/**
+ * Gets and/or sets the configuration of the Interactivity API for a given
+ * store namespace.
+ *
+ * If configuration for that store namespace exists, it merges the new
+ * provided configuration with the existing one.
+ *
+ * @since 6.5.0
+ *
+ * @param string $store_namespace The unique store namespace identifier.
+ * @param array $config Optional. The array that will be merged with the existing configuration for the
+ * specified store namespace.
+ * @return array The configuration for the specified store namespace. This will be the updated configuration if a
+ * $config argument was provided.
+ */
+function wp_interactivity_config( string $store_namespace, array $config = array() ): array {
+ return wp_interactivity()->config( $store_namespace, $config );
+}
+
+/**
+ * Generates a `data-wp-context` directive attribute by encoding a context
+ * array.
+ *
+ * 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 ) ); ?>>
+ *
+ * @since 6.5.0
+ *
+ * @param array $context The array of context data to encode.
+ * @param string $store_namespace Optional. 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.
+ */
+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 ) ) .
+ '\'';
+}