Changeset 58729 for trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php

Timestamp:

07/16/2024 09:42:38 AM (10 months ago)

Author:

Bernhard Reiter

Message:

Interactivity API: Use Script Modules filter for store & config data.

A dedicated API exists for passing data to Script Modules implemented in changeset [58579].
Use this Core API instead of a custom implementation for Interactivity API to pass data to the client.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/6683.

Props jonsurrell, gziolo, luisherranz, cbravobernal.
Fixes #61512.

File:

• trunk/src/wp-includes/interactivity-api/class-wp-interactivity-api.php (modified) (4 diffs)

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

@@ -193 +193 @@
      *
      * @since 6.5.0
+     *
+     * @deprecated 6.7.0 Client data passing is handled by the {@see "script_module_data_{$module_id}"} filter.
      */
     public function print_client_interactivity_data() {
+        _deprecated_function( __METHOD__, '6.7.0' );
+    }
+
+    /**
+     * Set client-side interactivity data.
+     *
+     * 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.7.0
+     *
+     * @param array $data Data to filter.
+     * @return array Data for the Interactivity API script module.
+     */
+    public function filter_script_module_interactivity_data( array $data ): array {
         if ( empty( $this->state_data ) && empty( $this->config_data ) ) {
-            return;
-        }
-
-        $interactivity_data = array();
+            return $data;
+        }
 
         $config = array();
@@ -208 +223 @@
         }
         if ( ! empty( $config ) ) {
-            $interactivity_data['config'] = $config;
+            $data['config'] = $config;
         }
 
@@ -218 +233 @@
         }
         if ( ! empty( $state ) ) {
-            $interactivity_data['state'] = $state;
-        }
-
-        if ( ! empty( $interactivity_data ) ) {
-            /*
-             * This data will be printed as JSON inside a script tag like this:
-             *   <script type="application/json"></script>
-             *
-             * A script tag must be closed by a sequence beginning with `</`. It's impossible to
-             * close a script tag without using `<`. We ensure that `<` is escaped and `/` can
-             * remain unescaped, so `</script>` will be printed as `\u003C/script\u00E3`.
-             *
-             *   - JSON_HEX_TAG: All < and > are converted to \u003C and \u003E.
-             *   - JSON_UNESCAPED_SLASHES: Don't escape /.
-             *
-             * If the page will use UTF-8 encoding, it's safe to print unescaped unicode:
-             *
-             *   - JSON_UNESCAPED_UNICODE: Encode multibyte Unicode characters literally (instead of as `\uXXXX`).
-             *   - JSON_UNESCAPED_LINE_TERMINATORS: The line terminators are kept unescaped when
-             *     JSON_UNESCAPED_UNICODE is supplied. It uses the same behaviour as it was
-             *     before PHP 7.1 without this constant. Available as of PHP 7.1.0.
-             *
-             * The JSON specification requires encoding in UTF-8, so if the generated HTML page
-             * is not encoded in UTF-8 then it's not safe to include those literals. They must
-             * be escaped to avoid encoding issues.
-             *
-             * @see https://www.rfc-editor.org/rfc/rfc8259.html for details on encoding requirements.
-             * @see https://www.php.net/manual/en/json.constants.php for details on these constants.
-             * @see https://html.spec.whatwg.org/#script-data-state for details on script tag parsing.
-             */
-            $json_encode_flags = JSON_HEX_TAG | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_LINE_TERMINATORS;
-            if ( ! is_utf8_charset() ) {
-                $json_encode_flags = JSON_HEX_TAG | JSON_UNESCAPED_SLASHES;
-            }
-
-            wp_print_inline_script_tag(
-                wp_json_encode(
-                    $interactivity_data,
-                    $json_encode_flags
-                ),
-                array(
-                    'type' => 'application/json',
-                    'id'   => 'wp-interactivity-data',
-                )
-            );
-        }
+            $data['state'] = $state;
+        }
+
+        return $data;
     }
 
@@ -330 +303 @@
      *
      * @since 6.5.0
+     * @since 6.7.0 Use the {@see "script_module_data_{$module_id}"} filter to pass client-side data.
      */
     public function add_hooks() {
         add_action( 'wp_enqueue_scripts', array( $this, 'register_script_modules' ) );
-        add_action( 'wp_footer', array( $this, 'print_client_interactivity_data' ) );
-
         add_action( 'admin_enqueue_scripts', array( $this, 'register_script_modules' ) );
-        add_action( 'admin_print_footer_scripts', array( $this, 'print_client_interactivity_data' ) );
+
+        add_filter( 'script_module_data_@wordpress/interactivity', array( $this, 'filter_script_module_interactivity_data' ) );
     }