Interactivity API: Directives cannot derive state on the server
The Interactivity API has a concept of "derived state" but it only worked on the client (JavaScript). This is the implementation that mirrors it, so derived state has good server-side solution. Props jonsurrell, darerodz, gziolo, luisherranz, cbravobernal. Fixes #61037. Built from https://develop.svn.wordpress.org/trunk@58327 git-svn-id: http://core.svn.wordpress.org/trunk@57784 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
parent
10642d626d
commit
70d2443a48
|
@ -73,6 +73,28 @@ final class WP_Interactivity_API {
|
||||||
*/
|
*/
|
||||||
private $has_processed_router_region = false;
|
private $has_processed_router_region = false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stack of namespaces defined by `data-wp-interactive` directives, in
|
||||||
|
* the order they are processed.
|
||||||
|
*
|
||||||
|
* This is only available during directive processing, otherwise it is `null`.
|
||||||
|
*
|
||||||
|
* @since 6.6.0
|
||||||
|
* @var array<string>|null
|
||||||
|
*/
|
||||||
|
private $namespace_stack = null;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stack of contexts defined by `data-wp-context` directives, in
|
||||||
|
* the order they are processed.
|
||||||
|
*
|
||||||
|
* This is only available during directive processing, otherwise it is `null`.
|
||||||
|
*
|
||||||
|
* @since 6.6.0
|
||||||
|
* @var array<array<mixed>>|null
|
||||||
|
*/
|
||||||
|
private $context_stack = null;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets and/or sets the initial state of an Interactivity API store for a
|
* Gets and/or sets the initial state of an Interactivity API store for a
|
||||||
* given namespace.
|
* given namespace.
|
||||||
|
@ -80,15 +102,47 @@ final class WP_Interactivity_API {
|
||||||
* If state for that store namespace already exists, it merges the new
|
* If state for that store namespace already exists, it merges the new
|
||||||
* provided state with the existing one.
|
* provided state with the existing one.
|
||||||
*
|
*
|
||||||
* @since 6.5.0
|
* When no namespace is specified, it returns the state defined for the
|
||||||
|
* current value in the internal namespace stack during a `process_directives` call.
|
||||||
*
|
*
|
||||||
* @param string $store_namespace The unique store namespace identifier.
|
* @since 6.5.0
|
||||||
|
* @since 6.6.0 The `$store_namespace` param is optional.
|
||||||
|
*
|
||||||
|
* @param string $store_namespace Optional. The unique store namespace identifier.
|
||||||
* @param array $state Optional. The array that will be merged with the existing state for the specified
|
* @param array $state Optional. The array that will be merged with the existing state for the specified
|
||||||
* store namespace.
|
* store namespace.
|
||||||
* @return array The current state for the specified store namespace. This will be the updated state if a $state
|
* @return array The current state for the specified store namespace. This will be the updated state if a $state
|
||||||
* argument was provided.
|
* argument was provided.
|
||||||
*/
|
*/
|
||||||
public function state( string $store_namespace, array $state = array() ): array {
|
public function state( ?string $store_namespace = null, ?array $state = null ): array {
|
||||||
|
if ( ! $store_namespace ) {
|
||||||
|
if ( $state ) {
|
||||||
|
_doing_it_wrong(
|
||||||
|
__METHOD__,
|
||||||
|
__( 'The namespace is required when state data is passed.' ),
|
||||||
|
'6.6.0'
|
||||||
|
);
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
if ( null !== $store_namespace ) {
|
||||||
|
_doing_it_wrong(
|
||||||
|
__METHOD__,
|
||||||
|
__( 'The namespace should be a non-empty string.' ),
|
||||||
|
'6.6.0'
|
||||||
|
);
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
if ( null === $this->namespace_stack ) {
|
||||||
|
_doing_it_wrong(
|
||||||
|
__METHOD__,
|
||||||
|
__( 'The namespace can only be omitted during directive processing.' ),
|
||||||
|
'6.6.0'
|
||||||
|
);
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
|
||||||
|
$store_namespace = end( $this->namespace_stack );
|
||||||
|
}
|
||||||
if ( ! isset( $this->state_data[ $store_namespace ] ) ) {
|
if ( ! isset( $this->state_data[ $store_namespace ] ) ) {
|
||||||
$this->state_data[ $store_namespace ] = array();
|
$this->state_data[ $store_namespace ] = array();
|
||||||
}
|
}
|
||||||
|
@ -211,6 +265,46 @@ final class WP_Interactivity_API {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the latest value on the context stack with the passed namespace.
|
||||||
|
*
|
||||||
|
* When the namespace is omitted, it uses the current namespace on the
|
||||||
|
* namespace stack during a `process_directives` call.
|
||||||
|
*
|
||||||
|
* @since 6.6.0
|
||||||
|
*
|
||||||
|
* @param string $store_namespace Optional. The unique store namespace identifier.
|
||||||
|
*/
|
||||||
|
public function get_context( ?string $store_namespace = null ): array {
|
||||||
|
if ( null === $this->context_stack ) {
|
||||||
|
_doing_it_wrong(
|
||||||
|
__METHOD__,
|
||||||
|
__( 'The context can only be read during directive processing.' ),
|
||||||
|
'6.6.0'
|
||||||
|
);
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
|
||||||
|
if ( ! $store_namespace ) {
|
||||||
|
if ( null !== $store_namespace ) {
|
||||||
|
_doing_it_wrong(
|
||||||
|
__METHOD__,
|
||||||
|
__( 'The namespace should be a non-empty string.' ),
|
||||||
|
'6.6.0'
|
||||||
|
);
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
|
||||||
|
$store_namespace = end( $this->namespace_stack );
|
||||||
|
}
|
||||||
|
|
||||||
|
$context = end( $this->context_stack );
|
||||||
|
|
||||||
|
return ( $store_namespace && $context && isset( $context[ $store_namespace ] ) )
|
||||||
|
? $context[ $store_namespace ]
|
||||||
|
: array();
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Registers the `@wordpress/interactivity` script modules.
|
* Registers the `@wordpress/interactivity` script modules.
|
||||||
*
|
*
|
||||||
|
@ -258,9 +352,14 @@ final class WP_Interactivity_API {
|
||||||
return $html;
|
return $html;
|
||||||
}
|
}
|
||||||
|
|
||||||
$context_stack = array();
|
$this->namespace_stack = array();
|
||||||
$namespace_stack = array();
|
$this->context_stack = array();
|
||||||
$result = $this->process_directives_args( $html, $context_stack, $namespace_stack );
|
|
||||||
|
$result = $this->_process_directives( $html );
|
||||||
|
|
||||||
|
$this->namespace_stack = null;
|
||||||
|
$this->context_stack = null;
|
||||||
|
|
||||||
return null === $result ? $html : $result;
|
return null === $result ? $html : $result;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -268,18 +367,17 @@ final class WP_Interactivity_API {
|
||||||
* Processes the interactivity directives contained within the HTML content
|
* Processes the interactivity directives contained within the HTML content
|
||||||
* and updates the markup accordingly.
|
* and updates the markup accordingly.
|
||||||
*
|
*
|
||||||
* It needs the context and namespace stacks to be passed by reference, and
|
* It uses the WP_Interactivity_API instance's context and namespace stacks,
|
||||||
* it returns null if the HTML contains unbalanced tags.
|
* which are shared between all calls.
|
||||||
*
|
*
|
||||||
* @since 6.5.0
|
* This method returns null if the HTML contains unbalanced tags.
|
||||||
* @since 6.6.0 The function displays a warning message when the HTML contains unbalanced tags or a directive appears in a MATH or SVG tag.
|
*
|
||||||
|
* @since 6.6.0
|
||||||
*
|
*
|
||||||
* @param string $html The HTML content to process.
|
* @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.
|
* @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 ) {
|
private function _process_directives( string $html ) {
|
||||||
$p = new WP_Interactivity_API_Directives_Processor( $html );
|
$p = new WP_Interactivity_API_Directives_Processor( $html );
|
||||||
$tag_stack = array();
|
$tag_stack = array();
|
||||||
$unbalanced = false;
|
$unbalanced = false;
|
||||||
|
@ -287,6 +385,13 @@ final class WP_Interactivity_API {
|
||||||
$directive_processor_prefixes = array_keys( self::$directive_processors );
|
$directive_processor_prefixes = array_keys( self::$directive_processors );
|
||||||
$directive_processor_prefixes_reversed = array_reverse( $directive_processor_prefixes );
|
$directive_processor_prefixes_reversed = array_reverse( $directive_processor_prefixes );
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Save the current size for each stack to restore them in case
|
||||||
|
* the processing finds unbalanced tags.
|
||||||
|
*/
|
||||||
|
$namespace_stack_size = count( $this->namespace_stack );
|
||||||
|
$context_stack_size = count( $this->context_stack );
|
||||||
|
|
||||||
while ( $p->next_tag( array( 'tag_closers' => 'visit' ) ) ) {
|
while ( $p->next_tag( array( 'tag_closers' => 'visit' ) ) ) {
|
||||||
$tag_name = $p->get_tag();
|
$tag_name = $p->get_tag();
|
||||||
|
|
||||||
|
@ -298,7 +403,7 @@ final class WP_Interactivity_API {
|
||||||
if ( 'SVG' === $tag_name || 'MATH' === $tag_name ) {
|
if ( 'SVG' === $tag_name || 'MATH' === $tag_name ) {
|
||||||
if ( $p->get_attribute_names_with_prefix( 'data-wp-' ) ) {
|
if ( $p->get_attribute_names_with_prefix( 'data-wp-' ) ) {
|
||||||
/* translators: 1: SVG or MATH HTML tag, 2: Namespace of the interactive block. */
|
/* translators: 1: SVG or MATH HTML tag, 2: Namespace of the interactive block. */
|
||||||
$message = sprintf( __( 'Interactivity directives were detected on an incompatible %1$s tag when processing "%2$s". These directives will be ignored in the server side render.' ), $tag_name, end( $namespace_stack ) );
|
$message = sprintf( __( 'Interactivity directives were detected on an incompatible %1$s tag when processing "%2$s". These directives will be ignored in the server side render.' ), $tag_name, end( $this->namespace_stack ) );
|
||||||
_doing_it_wrong( __METHOD__, $message, '6.6.0' );
|
_doing_it_wrong( __METHOD__, $message, '6.6.0' );
|
||||||
}
|
}
|
||||||
$p->skip_to_tag_closer();
|
$p->skip_to_tag_closer();
|
||||||
|
@ -381,13 +486,17 @@ final class WP_Interactivity_API {
|
||||||
? self::$directive_processors[ $directive_prefix ]
|
? self::$directive_processors[ $directive_prefix ]
|
||||||
: array( $this, self::$directive_processors[ $directive_prefix ] );
|
: array( $this, self::$directive_processors[ $directive_prefix ] );
|
||||||
|
|
||||||
call_user_func_array(
|
call_user_func_array( $func, array( $p, $mode, &$tag_stack ) );
|
||||||
$func,
|
|
||||||
array( $p, $mode, &$context_stack, &$namespace_stack, &$tag_stack )
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if ( $unbalanced ) {
|
||||||
|
// Reset the namespace and context stacks to their previous values.
|
||||||
|
array_splice( $this->namespace_stack, $namespace_stack_size );
|
||||||
|
array_splice( $this->context_stack, $context_stack_size );
|
||||||
|
}
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* It returns null if the HTML is unbalanced because unbalanced HTML is
|
* It returns null if the HTML is unbalanced because unbalanced HTML is
|
||||||
* not safe to process. In that case, the Interactivity API runtime will
|
* not safe to process. In that case, the Interactivity API runtime will
|
||||||
|
@ -397,7 +506,7 @@ final class WP_Interactivity_API {
|
||||||
if ( $unbalanced || 0 < count( $tag_stack ) ) {
|
if ( $unbalanced || 0 < count( $tag_stack ) ) {
|
||||||
$tag_errored = 0 < count( $tag_stack ) ? end( $tag_stack )[0] : $tag_name;
|
$tag_errored = 0 < count( $tag_stack ) ? end( $tag_stack )[0] : $tag_name;
|
||||||
/* translators: %1s: Namespace processed, %2s: The tag that caused the error; could be any HTML tag. */
|
/* translators: %1s: Namespace processed, %2s: The tag that caused the error; could be any HTML tag. */
|
||||||
$message = sprintf( __( 'Interactivity directives failed to process in "%1$s" due to a missing "%2$s" end tag.' ), end( $namespace_stack ), $tag_errored );
|
$message = sprintf( __( 'Interactivity directives failed to process in "%1$s" due to a missing "%2$s" end tag.' ), end( $this->namespace_stack ), $tag_errored );
|
||||||
_doing_it_wrong( __METHOD__, $message, '6.6.0' );
|
_doing_it_wrong( __METHOD__, $message, '6.6.0' );
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
@ -411,15 +520,15 @@ final class WP_Interactivity_API {
|
||||||
*
|
*
|
||||||
* @since 6.5.0
|
* @since 6.5.0
|
||||||
* @since 6.6.0 The function now adds a warning when the namespace is null, falsy, or the directive value is empty.
|
* @since 6.6.0 The function now adds a warning when the namespace is null, falsy, or the directive value is empty.
|
||||||
|
* @since 6.6.0 Removed `default_namespace` and `context` arguments.
|
||||||
*
|
*
|
||||||
* @param string|true $directive_value The directive attribute value string or `true` when it's a boolean attribute.
|
* @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 or the namespace is falsy.
|
* @return mixed|null The result of the evaluation. Null if the reference path doesn't exist or the namespace is falsy.
|
||||||
*/
|
*/
|
||||||
private function evaluate( $directive_value, string $default_namespace, $context = false ) {
|
private function evaluate( $directive_value ) {
|
||||||
|
$default_namespace = end( $this->namespace_stack );
|
||||||
|
$context = end( $this->context_stack );
|
||||||
|
|
||||||
list( $ns, $path ) = $this->extract_directive_value( $directive_value, $default_namespace );
|
list( $ns, $path ) = $this->extract_directive_value( $directive_value, $default_namespace );
|
||||||
if ( ! $ns || ! $path ) {
|
if ( ! $ns || ! $path ) {
|
||||||
/* translators: %s: The directive value referenced. */
|
/* translators: %s: The directive value referenced. */
|
||||||
|
@ -450,6 +559,33 @@ final class WP_Interactivity_API {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if ( $current instanceof Closure ) {
|
||||||
|
/*
|
||||||
|
* This state getter's namespace is added to the stack so that
|
||||||
|
* `state()` or `get_config()` read that namespace when called
|
||||||
|
* without specifying one.
|
||||||
|
*/
|
||||||
|
array_push( $this->namespace_stack, $ns );
|
||||||
|
try {
|
||||||
|
$current = $current();
|
||||||
|
} catch ( Throwable $e ) {
|
||||||
|
_doing_it_wrong(
|
||||||
|
__METHOD__,
|
||||||
|
sprintf(
|
||||||
|
/* translators: 1: Path pointing to an Interactivity API state property, 2: Namespace for an Interactivity API store. */
|
||||||
|
__( 'Uncaught error executing a derived state callback with path "%1$s" and namespace "%2$s".' ),
|
||||||
|
$path,
|
||||||
|
$ns
|
||||||
|
),
|
||||||
|
'6.6.0'
|
||||||
|
);
|
||||||
|
return null;
|
||||||
|
} finally {
|
||||||
|
// Remove the property's namespace from the stack.
|
||||||
|
array_pop( $this->namespace_stack );
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Returns the opposite if it contains a negation operator (!).
|
// Returns the opposite if it contains a negation operator (!).
|
||||||
return $should_negate_value ? ! $current : $current;
|
return $should_negate_value ? ! $current : $current;
|
||||||
}
|
}
|
||||||
|
@ -553,13 +689,11 @@ final class WP_Interactivity_API {
|
||||||
*
|
*
|
||||||
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
||||||
* @param string $mode Whether the processing is entering or exiting the tag.
|
* @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 ) {
|
private function data_wp_interactive_processor( WP_Interactivity_API_Directives_Processor $p, string $mode ) {
|
||||||
// When exiting tags, it removes the last namespace from the stack.
|
// When exiting tags, it removes the last namespace from the stack.
|
||||||
if ( 'exit' === $mode ) {
|
if ( 'exit' === $mode ) {
|
||||||
array_pop( $namespace_stack );
|
array_pop( $this->namespace_stack );
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -583,9 +717,9 @@ final class WP_Interactivity_API {
|
||||||
$new_namespace = $attribute_value;
|
$new_namespace = $attribute_value;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
$namespace_stack[] = ( $new_namespace && 1 === preg_match( '/^([\w\-_\/]+)/', $new_namespace ) )
|
$this->namespace_stack[] = ( $new_namespace && 1 === preg_match( '/^([\w\-_\/]+)/', $new_namespace ) )
|
||||||
? $new_namespace
|
? $new_namespace
|
||||||
: end( $namespace_stack );
|
: end( $this->namespace_stack );
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -598,18 +732,16 @@ final class WP_Interactivity_API {
|
||||||
*
|
*
|
||||||
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
||||||
* @param string $mode Whether the processing is entering or exiting the tag.
|
* @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 ) {
|
private function data_wp_context_processor( WP_Interactivity_API_Directives_Processor $p, string $mode ) {
|
||||||
// When exiting tags, it removes the last context from the stack.
|
// When exiting tags, it removes the last context from the stack.
|
||||||
if ( 'exit' === $mode ) {
|
if ( 'exit' === $mode ) {
|
||||||
array_pop( $context_stack );
|
array_pop( $this->context_stack );
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
$attribute_value = $p->get_attribute( 'data-wp-context' );
|
$attribute_value = $p->get_attribute( 'data-wp-context' );
|
||||||
$namespace_value = end( $namespace_stack );
|
$namespace_value = end( $this->namespace_stack );
|
||||||
|
|
||||||
// Separates the namespace from the context JSON object.
|
// Separates the namespace from the context JSON object.
|
||||||
list( $namespace_value, $decoded_json ) = is_string( $attribute_value ) && ! empty( $attribute_value )
|
list( $namespace_value, $decoded_json ) = is_string( $attribute_value ) && ! empty( $attribute_value )
|
||||||
|
@ -621,8 +753,8 @@ final class WP_Interactivity_API {
|
||||||
* previous context with the new one.
|
* previous context with the new one.
|
||||||
*/
|
*/
|
||||||
if ( is_string( $namespace_value ) ) {
|
if ( is_string( $namespace_value ) ) {
|
||||||
$context_stack[] = array_replace_recursive(
|
$this->context_stack[] = array_replace_recursive(
|
||||||
end( $context_stack ) !== false ? end( $context_stack ) : array(),
|
end( $this->context_stack ) !== false ? end( $this->context_stack ) : array(),
|
||||||
array( $namespace_value => is_array( $decoded_json ) ? $decoded_json : array() )
|
array( $namespace_value => is_array( $decoded_json ) ? $decoded_json : array() )
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
|
@ -631,7 +763,7 @@ final class WP_Interactivity_API {
|
||||||
* It needs to do so because the function pops out the current context
|
* 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.
|
* from the stack whenever it finds a `data-wp-context`'s closing tag.
|
||||||
*/
|
*/
|
||||||
$context_stack[] = end( $context_stack );
|
$this->context_stack[] = end( $this->context_stack );
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -645,10 +777,8 @@ final class WP_Interactivity_API {
|
||||||
*
|
*
|
||||||
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
||||||
* @param string $mode Whether the processing is entering or exiting the tag.
|
* @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 ) {
|
private function data_wp_bind_processor( WP_Interactivity_API_Directives_Processor $p, string $mode ) {
|
||||||
if ( 'enter' === $mode ) {
|
if ( 'enter' === $mode ) {
|
||||||
$all_bind_directives = $p->get_attribute_names_with_prefix( 'data-wp-bind--' );
|
$all_bind_directives = $p->get_attribute_names_with_prefix( 'data-wp-bind--' );
|
||||||
|
|
||||||
|
@ -659,7 +789,7 @@ final class WP_Interactivity_API {
|
||||||
}
|
}
|
||||||
|
|
||||||
$attribute_value = $p->get_attribute( $attribute_name );
|
$attribute_value = $p->get_attribute( $attribute_name );
|
||||||
$result = $this->evaluate( $attribute_value, end( $namespace_stack ), end( $context_stack ) );
|
$result = $this->evaluate( $attribute_value );
|
||||||
|
|
||||||
if (
|
if (
|
||||||
null !== $result &&
|
null !== $result &&
|
||||||
|
@ -699,10 +829,8 @@ final class WP_Interactivity_API {
|
||||||
*
|
*
|
||||||
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
||||||
* @param string $mode Whether the processing is entering or exiting the tag.
|
* @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 ) {
|
private function data_wp_class_processor( WP_Interactivity_API_Directives_Processor $p, string $mode ) {
|
||||||
if ( 'enter' === $mode ) {
|
if ( 'enter' === $mode ) {
|
||||||
$all_class_directives = $p->get_attribute_names_with_prefix( 'data-wp-class--' );
|
$all_class_directives = $p->get_attribute_names_with_prefix( 'data-wp-class--' );
|
||||||
|
|
||||||
|
@ -713,7 +841,7 @@ final class WP_Interactivity_API {
|
||||||
}
|
}
|
||||||
|
|
||||||
$attribute_value = $p->get_attribute( $attribute_name );
|
$attribute_value = $p->get_attribute( $attribute_name );
|
||||||
$result = $this->evaluate( $attribute_value, end( $namespace_stack ), end( $context_stack ) );
|
$result = $this->evaluate( $attribute_value );
|
||||||
|
|
||||||
if ( $result ) {
|
if ( $result ) {
|
||||||
$p->add_class( $class_name );
|
$p->add_class( $class_name );
|
||||||
|
@ -734,10 +862,8 @@ final class WP_Interactivity_API {
|
||||||
*
|
*
|
||||||
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
||||||
* @param string $mode Whether the processing is entering or exiting the tag.
|
* @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 ) {
|
private function data_wp_style_processor( WP_Interactivity_API_Directives_Processor $p, string $mode ) {
|
||||||
if ( 'enter' === $mode ) {
|
if ( 'enter' === $mode ) {
|
||||||
$all_style_attributes = $p->get_attribute_names_with_prefix( 'data-wp-style--' );
|
$all_style_attributes = $p->get_attribute_names_with_prefix( 'data-wp-style--' );
|
||||||
|
|
||||||
|
@ -748,7 +874,7 @@ final class WP_Interactivity_API {
|
||||||
}
|
}
|
||||||
|
|
||||||
$directive_attribute_value = $p->get_attribute( $attribute_name );
|
$directive_attribute_value = $p->get_attribute( $attribute_name );
|
||||||
$style_property_value = $this->evaluate( $directive_attribute_value, end( $namespace_stack ), end( $context_stack ) );
|
$style_property_value = $this->evaluate( $directive_attribute_value );
|
||||||
$style_attribute_value = $p->get_attribute( 'style' );
|
$style_attribute_value = $p->get_attribute( 'style' );
|
||||||
$style_attribute_value = ( $style_attribute_value && ! is_bool( $style_attribute_value ) ) ? $style_attribute_value : '';
|
$style_attribute_value = ( $style_attribute_value && ! is_bool( $style_attribute_value ) ) ? $style_attribute_value : '';
|
||||||
|
|
||||||
|
@ -827,13 +953,11 @@ final class WP_Interactivity_API {
|
||||||
*
|
*
|
||||||
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
||||||
* @param string $mode Whether the processing is entering or exiting the tag.
|
* @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 ) {
|
private function data_wp_text_processor( WP_Interactivity_API_Directives_Processor $p, string $mode ) {
|
||||||
if ( 'enter' === $mode ) {
|
if ( 'enter' === $mode ) {
|
||||||
$attribute_value = $p->get_attribute( 'data-wp-text' );
|
$attribute_value = $p->get_attribute( 'data-wp-text' );
|
||||||
$result = $this->evaluate( $attribute_value, end( $namespace_stack ), end( $context_stack ) );
|
$result = $this->evaluate( $attribute_value );
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Follows the same logic as Preact in the client and only changes the
|
* Follows the same logic as Preact in the client and only changes the
|
||||||
|
@ -965,17 +1089,15 @@ HTML;
|
||||||
*
|
*
|
||||||
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
* @param WP_Interactivity_API_Directives_Processor $p The directives processor instance.
|
||||||
* @param string $mode Whether the processing is entering or exiting the tag.
|
* @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.
|
* @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 ) {
|
private function data_wp_each_processor( WP_Interactivity_API_Directives_Processor $p, string $mode, array &$tag_stack ) {
|
||||||
if ( 'enter' === $mode && 'TEMPLATE' === $p->get_tag() ) {
|
if ( 'enter' === $mode && 'TEMPLATE' === $p->get_tag() ) {
|
||||||
$attribute_name = $p->get_attribute_names_with_prefix( 'data-wp-each' )[0];
|
$attribute_name = $p->get_attribute_names_with_prefix( 'data-wp-each' )[0];
|
||||||
$extracted_suffix = $this->extract_prefix_and_suffix( $attribute_name );
|
$extracted_suffix = $this->extract_prefix_and_suffix( $attribute_name );
|
||||||
$item_name = isset( $extracted_suffix[1] ) ? $this->kebab_to_camel_case( $extracted_suffix[1] ) : 'item';
|
$item_name = isset( $extracted_suffix[1] ) ? $this->kebab_to_camel_case( $extracted_suffix[1] ) : 'item';
|
||||||
$attribute_value = $p->get_attribute( $attribute_name );
|
$attribute_value = $p->get_attribute( $attribute_name );
|
||||||
$result = $this->evaluate( $attribute_value, end( $namespace_stack ), end( $context_stack ) );
|
$result = $this->evaluate( $attribute_value );
|
||||||
|
|
||||||
// Gets the content between the template tags and leaves the cursor in the closer tag.
|
// Gets the content between the template tags and leaves the cursor in the closer tag.
|
||||||
$inner_content = $p->get_content_between_balanced_template_tags();
|
$inner_content = $p->get_content_between_balanced_template_tags();
|
||||||
|
@ -1009,7 +1131,7 @@ HTML;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Extracts the namespace from the directive attribute value.
|
// Extracts the namespace from the directive attribute value.
|
||||||
$namespace_value = end( $namespace_stack );
|
$namespace_value = end( $this->namespace_stack );
|
||||||
list( $namespace_value ) = is_string( $attribute_value ) && ! empty( $attribute_value )
|
list( $namespace_value ) = is_string( $attribute_value ) && ! empty( $attribute_value )
|
||||||
? $this->extract_directive_value( $attribute_value, $namespace_value )
|
? $this->extract_directive_value( $attribute_value, $namespace_value )
|
||||||
: array( $namespace_value, null );
|
: array( $namespace_value, null );
|
||||||
|
@ -1018,17 +1140,17 @@ HTML;
|
||||||
$processed_content = '';
|
$processed_content = '';
|
||||||
foreach ( $result as $item ) {
|
foreach ( $result as $item ) {
|
||||||
// Creates a new context that includes the current item of the array.
|
// Creates a new context that includes the current item of the array.
|
||||||
$context_stack[] = array_replace_recursive(
|
$this->context_stack[] = array_replace_recursive(
|
||||||
end( $context_stack ) !== false ? end( $context_stack ) : array(),
|
end( $this->context_stack ) !== false ? end( $this->context_stack ) : array(),
|
||||||
array( $namespace_value => array( $item_name => $item ) )
|
array( $namespace_value => array( $item_name => $item ) )
|
||||||
);
|
);
|
||||||
|
|
||||||
// Processes the inner content with the new context.
|
// Processes the inner content with the new context.
|
||||||
$processed_item = $this->process_directives_args( $inner_content, $context_stack, $namespace_stack );
|
$processed_item = $this->_process_directives( $inner_content );
|
||||||
|
|
||||||
if ( null === $processed_item ) {
|
if ( null === $processed_item ) {
|
||||||
// If the HTML is unbalanced, stop processing it.
|
// If the HTML is unbalanced, stop processing it.
|
||||||
array_pop( $context_stack );
|
array_pop( $this->context_stack );
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1041,7 +1163,7 @@ HTML;
|
||||||
$processed_content .= $i->get_updated_html();
|
$processed_content .= $i->get_updated_html();
|
||||||
|
|
||||||
// Removes the current context from the stack.
|
// Removes the current context from the stack.
|
||||||
array_pop( $context_stack );
|
array_pop( $this->context_stack );
|
||||||
}
|
}
|
||||||
|
|
||||||
// Appends the processed content after the tag closer of the template.
|
// Appends the processed content after the tag closer of the template.
|
||||||
|
|
|
@ -47,7 +47,11 @@ function wp_interactivity_process_directives( string $html ): string {
|
||||||
* If state for that store namespace already exists, it merges the new
|
* If state for that store namespace already exists, it merges the new
|
||||||
* provided state with the existing one.
|
* provided state with the existing one.
|
||||||
*
|
*
|
||||||
|
* The namespace can be omitted inside derived state getters, using the
|
||||||
|
* namespace where the getter is defined.
|
||||||
|
*
|
||||||
* @since 6.5.0
|
* @since 6.5.0
|
||||||
|
* @since 6.6.0 The namespace can be omitted when called inside derived state getters.
|
||||||
*
|
*
|
||||||
* @param string $store_namespace The unique store namespace identifier.
|
* @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
|
* @param array $state Optional. The array that will be merged with the existing state for the specified
|
||||||
|
@ -55,7 +59,7 @@ function wp_interactivity_process_directives( string $html ): string {
|
||||||
* @return array The state for the specified store namespace. This will be the updated state if a $state argument was
|
* @return array The state for the specified store namespace. This will be the updated state if a $state argument was
|
||||||
* provided.
|
* provided.
|
||||||
*/
|
*/
|
||||||
function wp_interactivity_state( string $store_namespace, array $state = array() ): array {
|
function wp_interactivity_state( ?string $store_namespace = null, array $state = array() ): array {
|
||||||
return wp_interactivity()->state( $store_namespace, $state );
|
return wp_interactivity()->state( $store_namespace, $state );
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -103,3 +107,21 @@ function wp_interactivity_data_wp_context( array $context, string $store_namespa
|
||||||
( empty( $context ) ? '{}' : wp_json_encode( $context, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP ) ) .
|
( empty( $context ) ? '{}' : wp_json_encode( $context, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_QUOT | JSON_HEX_AMP ) ) .
|
||||||
'\'';
|
'\'';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the current Interactivity API context for a given namespace.
|
||||||
|
*
|
||||||
|
* The function should be used only during directive processing. If the
|
||||||
|
* `$store_namespace` parameter is omitted, it uses the current namespace value
|
||||||
|
* on the internal namespace stack.
|
||||||
|
*
|
||||||
|
* It returns an empty array when the specified namespace is not defined.
|
||||||
|
*
|
||||||
|
* @since 6.6.0
|
||||||
|
*
|
||||||
|
* @param string $store_namespace Optional. The unique store namespace identifier.
|
||||||
|
* @return array The context for the specified store namespace.
|
||||||
|
*/
|
||||||
|
function wp_interactivity_get_context( ?string $store_namespace = null ): array {
|
||||||
|
return wp_interactivity()->get_context( $store_namespace );
|
||||||
|
}
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
*
|
*
|
||||||
* @global string $wp_version
|
* @global string $wp_version
|
||||||
*/
|
*/
|
||||||
$wp_version = '6.6-alpha-58326';
|
$wp_version = '6.6-alpha-58327';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||||
|
|
Loading…
Reference in New Issue