Merge branch 'trunk' into html-api/add-css-selector-parser

WordPress · Dec 11, 2024 · 1c1e29a · 1c1e29a
2 parents abb4d25 + 9104190
commit 1c1e29a
Showing 1 changed file with 20 additions and 17 deletions.
diff --git a/src/wp-includes/class-wp-script-modules.php b/src/wp-includes/class-wp-script-modules.php
@@ -407,14 +407,15 @@ public function print_script_module_data(): void {
 			 * initialization or immediately on page load. It does not replace the REST API or
 			 * 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.
 			 *
@@ -423,15 +424,17 @@ public function print_script_module_data(): void {
 			 *
 			 * 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
 			 *