Changeset 58825

Timestamp:

07/29/2024 11:08:18 AM (2 years ago)

Author:

luisherranz

Message:

Interactivity API: Allow server derived state to appear in non-final position

In some cases, derived state returns an associative array. Directives may wish to continue to access properties of the associative array, when using the syntax state.arrayReturnedByClosure.property. This patch continues evaluating the path after the associative array has been returned by the Closure.

Props jonsurrell, luisherranz.

Fixes #61741.

Location:

trunk

Files:

• src/wp-includes/interactivity-api/class-wp-interactivity-api.php (modified) (2 diffs)
• tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php (modified) (2 diffs)

trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php

@@ -495 +495 @@
          * @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.
+         * @since 6.6.0 Add support for derived state.
          *
          * @param string|true $directive_value The directive attribute value string or `true` when it's a boolean attribute.
@@ -531 +532 @@
                                 return null;
                         }
-                }
-
-                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 );
+
+                        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 );
+                                }
                         }
                 }

trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php

@@ -1298 +1298 @@
         }
 
-
         /**
          * Tests the `evaluate` method for derived state functions that throw.
@@ -1321 +1320 @@
                 $result = $this->evaluate( 'state.derivedThatThrows' );
                 $this->assertNull( $result );
+        }
+
+        /**
+         * Tests the `evaluate` method for derived state intermediate values.
+         *
+         * @ticket 61741
+         *
+         * @covers ::evaluate
+         */
+        public function test_evaluate_derived_state_intermediate() {
+                $this->interactivity->state(
+                        'myPlugin',
+                        array(
+                                'derivedState' => function () {
+                                        return array( 'property' => 'value' );
+                                },
+                        )
+                );
+                $this->set_internal_context_stack();
+                $this->set_internal_namespace_stack( 'myPlugin' );
+
+                $result = $this->evaluate( 'state.derivedState.property' );
+                $this->assertSame( 'value', $result );
         }