Changeset 59505 for trunk/src/wp-includes/class-wp-script-modules.php

Timestamp:

12/11/2024 03:18:43 PM (22 months ago)

Author:

SergeyBiryukov

Message:

Docs: Correct formatting for script module data filter documentation examples.

Follow-up to [58579].

Props jonsurrell.
See #62281.

File:

• trunk/src/wp-includes/class-wp-script-modules.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-script-modules.php

@@ -408 +408 @@
                          * fetching data from the client.
                          *
-                         * @example
-                         *   add_filter(
-                         *     'script_module_data_MyScriptModuleID',
-                         *     function ( array $data ): array {
-                         *       $data['script-needs-this-data'] = 'ok';
-                         *       return $data;
-                         *     }
-                         *   );
+                         * Example:
+                         *
+                         *     add_filter(
+                         *         'script_module_data_MyScriptModuleID',
+                         *         function ( array $data ): array {
+                         *             $data['dataForClient'] = 'ok';
+                         *             return $data;
+                         *         }
+                         *     );
                          *
                          * If the filter returns no data (an empty array), nothing will be embedded in the page.
@@ -424 +425 @@
                          * The data can be read on the client with a pattern like this:
                          *
-                         * @example
-                         *   const dataContainer = document.getElementById( 'wp-script-module-data-MyScriptModuleID' );
-                         *   let data = {};
-                         *   if ( dataContainer ) {
-                         *     try {
-                         *       data = JSON.parse( dataContainer.textContent );
-                         *     } catch {}
-                         *   }
-                         *   initMyScriptModuleWithData( data );
+                         * Example:
+                         *
+                         *     const dataContainer = document.getElementById( 'wp-script-module-data-MyScriptModuleID' );
+                         *     let data = {};
+                         *     if ( dataContainer ) {
+                         *         try {
+                         *             data = JSON.parse( dataContainer.textContent );
+                         *         } catch {}
+                         *     }
+                         *     // data.dataForClient === 'ok';
+                         *     initMyScriptModuleWithData( data );
                          *
                          * @since 6.7.0