Changeset 57742

Timestamp:

02/29/2024 12:26:19 PM (5 months ago)

Author:

swissspidy

Message:

Interactivity API: Rename data_wp_context() to wp_interactivity_data_wp_context().

Increases clarity about where the function belongs to, bringing it in line with other related functions.

Props swissspidy, gziolo, cbravobernal, youknowriad, ankitmaru, westonruter, luisherranz, darerodz.
Fixes #60575.

Location:

trunk

Files:

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

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

@@ -150 +150 @@
  * Example:
  *
- *     <div <?php echo data_wp_context( array( 'isOpen' => true, 'count' => 0 ) ); ?>>
+ *     <div <?php echo data_wp_context( array( 'isOpen' => true, 'count' => 0 ) ); ?>>
  *
  * @since 6.5.0
@@ -159 +159 @@
  *                the store namespace if specified.
  */
-function data_wp_context( array $context, string $store_namespace = '' ): string {
+function data_wp_context( array $context, string $store_namespace = '' ): string {
     return 'data-wp-context=\'' .
         ( $store_namespace ? $store_namespace . '::' : '' ) .

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

@@ -315 +315 @@
 
     /**
-     * Tests that data_wp_context function correctly converts different array
+     * Tests that data_wp_context function correctly converts different array
      * structures to a JSON string.
      *
      * @ticket 60356
      *
-     * @covers ::data_wp_context
-     */
-    public function test_data_wp_context_with_different_arrays() {
-        $this->assertEquals( 'data-wp-context=\'{}\'', data_wp_context( array() ) );
+     * @covers ::data_wp_context
+     */
+    public function test_data_wp_context_with_different_arrays() {
+        $this->assertEquals( 'data-wp-context=\'{}\'', data_wp_context( array() ) );
         $this->assertEquals(
             'data-wp-context=\'{"a":1,"b":"2","c":true}\'',
-            data_wp_context(
+            data_wp_context(
                 array(
                     'a' => 1,
@@ -336 +336 @@
         $this->assertEquals(
             'data-wp-context=\'{"a":[1,2]}\'',
-            data_wp_context( array( 'a' => array( 1, 2 ) ) )
+            data_wp_context( array( 'a' => array( 1, 2 ) ) )
         );
         $this->assertEquals(
             'data-wp-context=\'[1,2]\'',
-            data_wp_context( array( 1, 2 ) )
-        );
-    }
-
-    /**
-     * Tests that data_wp_context function correctly converts different array
+            data_wp_context( array( 1, 2 ) )
+        );
+    }
+
+    /**
+     * Tests that data_wp_context function correctly converts different array
      * structures to a JSON string and adds a namespace.
      *
      * @ticket 60356
      *
-     * @covers ::data_wp_context
-     */
-    public function test_data_wp_context_with_different_arrays_and_a_namespace() {
-        $this->assertEquals( 'data-wp-context=\'myPlugin::{}\'', data_wp_context( array(), 'myPlugin' ) );
+     * @covers ::data_wp_context
+     */
+    public function test_data_wp_context_with_different_arrays_and_a_namespace() {
+        $this->assertEquals( 'data-wp-context=\'myPlugin::{}\'', data_wp_context( array(), 'myPlugin' ) );
         $this->assertEquals(
             'data-wp-context=\'myPlugin::{"a":1,"b":"2","c":true}\'',
-            data_wp_context(
+            data_wp_context(
                 array(
                     'a' => 1,
@@ -367 +367 @@
         $this->assertEquals(
             'data-wp-context=\'myPlugin::{"a":[1,2]}\'',
-            data_wp_context( array( 'a' => array( 1, 2 ) ), 'myPlugin' )
+            data_wp_context( array( 'a' => array( 1, 2 ) ), 'myPlugin' )
         );
         $this->assertEquals(
             'data-wp-context=\'myPlugin::[1,2]\'',
-            data_wp_context( array( 1, 2 ), 'myPlugin' )
-        );
-    }
-
-    /**
-     * Tests that data_wp_context function correctly applies the JSON encoding
+            data_wp_context( array( 1, 2 ), 'myPlugin' )
+        );
+    }
+
+    /**
+     * Tests that data_wp_context function correctly applies the JSON encoding
      * flags. This ensures that characters like `<`, `>`, `'`, or `&` are
      * properly escaped in the JSON-encoded string to prevent potential XSS
@@ -383 +383 @@
      * @ticket 60356
      *
-     * @covers ::data_wp_context
-     */
-    public function test_data_wp_context_with_json_flags() {
-        $this->assertEquals( 'data-wp-context=\'{"tag":"\u003Cfoo\u003E"}\'', data_wp_context( array( 'tag' => '<foo>' ) ) );
-        $this->assertEquals( 'data-wp-context=\'{"apos":"\u0027bar\u0027"}\'', data_wp_context( array( 'apos' => "'bar'" ) ) );
-        $this->assertEquals( 'data-wp-context=\'{"quot":"\u0022baz\u0022"}\'', data_wp_context( array( 'quot' => '"baz"' ) ) );
-        $this->assertEquals( 'data-wp-context=\'{"amp":"T\u0026T"}\'', data_wp_context( array( 'amp' => 'T&T' ) ) );
+     * @covers ::data_wp_context
+     */
+    public function test_data_wp_context_with_json_flags() {
+        $this->assertEquals( 'data-wp-context=\'{"tag":"\u003Cfoo\u003E"}\'', data_wp_context( array( 'tag' => '<foo>' ) ) );
+        $this->assertEquals( 'data-wp-context=\'{"apos":"\u0027bar\u0027"}\'', data_wp_context( array( 'apos' => "'bar'" ) ) );
+        $this->assertEquals( 'data-wp-context=\'{"quot":"\u0022baz\u0022"}\'', data_wp_context( array( 'quot' => '"baz"' ) ) );
+        $this->assertEquals( 'data-wp-context=\'{"amp":"T\u0026T"}\'', data_wp_context( array( 'amp' => 'T&T' ) ) );
     }
 }