Changeset 56194 for trunk/src/wp-includes/script-loader.php

Timestamp:

07/10/2023 11:09:16 PM (15 months ago)

Author:

audrasjb

Message:

Docs: Replace multiple single line comments with multi-line comments.

This changeset updates various comments as per WordPress PHP Inline Documentation Standards.
See ​https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#5-inline-comments.

Follow-up to [56174], [56175], [56176], [56177], [56178], [56179], [56180], [56191], [56192], [56193].

Props costdev, audrasjb.
See #58459.

File:

• trunk/src/wp-includes/script-loader.php (modified) (10 diffs)

trunk/src/wp-includes/script-loader.php

@@ -58 +58 @@
         && false !== stripos( $_SERVER['HTTP_ACCEPT_ENCODING'], 'gzip' ) && ! $force_uncompressed;
 
-    // Load tinymce.js when running from /src, otherwise load wp-tinymce.js.gz (in production)
-    // or tinymce.min.js (when SCRIPT_DEBUG is true).
+    /*
+     * Load tinymce.js when running from /src, otherwise load wp-tinymce.js.gz (in production)
+     * or tinymce.min.js (when SCRIPT_DEBUG is true).
+     */
     if ( $compressed ) {
         $scripts->add( 'wp-tinymce', includes_url( 'js/tinymce/' ) . 'wp-tinymce.js', array(), $tinymce_version );
@@ -586 +588 @@
     $tinymce_settings = apply_filters( 'tiny_mce_before_init', $tinymce_settings, 'classic-block' );
 
-    // Do "by hand" translation from PHP array to js object.
-    // Prevents breakage in some custom settings.
+    /*
+     * Do "by hand" translation from PHP array to js object.
+     * Prevents breakage in some custom settings.
+     */
     $init_obj = '';
     foreach ( $tinymce_settings as $key => $value ) {
@@ -826 +830 @@
     $scripts->add( 'cropper', '/wp-includes/js/crop/cropper.js', array( 'scriptaculous-dragdrop' ) );
 
-    // jQuery.
-    // The unminified jquery.js and jquery-migrate.js are included to facilitate debugging.
+    /*
+     * jQuery.
+     * The unminified jquery.js and jquery-migrate.js are included to facilitate debugging.
+     */
     $scripts->add( 'jquery', false, array( 'jquery-core', 'jquery-migrate' ), '3.7.0' );
     $scripts->add( 'jquery-core', "/wp-includes/js/jquery/jquery$suffix.js", array(), '3.7.0' );
     $scripts->add( 'jquery-migrate', "/wp-includes/js/jquery/jquery-migrate$suffix.js", array(), '3.4.1' );
 
-    // Full jQuery UI.
-    // The build process in 1.12.1 has changed significantly.
-    // In order to keep backwards compatibility, and to keep the optimized loading,
-    // the source files were flattened and included with some modifications for AMD loading.
-    // A notable change is that 'jquery-ui-core' now contains 'jquery-ui-position' and 'jquery-ui-widget'.
+    /*
+     * Full jQuery UI.
+     * The build process in 1.12.1 has changed significantly.
+     * In order to keep backwards compatibility, and to keep the optimized loading,
+     * the source files were flattened and included with some modifications for AMD loading.
+     * A notable change is that 'jquery-ui-core' now contains 'jquery-ui-position' and 'jquery-ui-widget'.
+     */
     $scripts->add( 'jquery-ui-core', "/wp-includes/js/jquery/ui/core$suffix.js", array( 'jquery' ), '1.13.2', 1 );
     $scripts->add( 'jquery-effects-core', "/wp-includes/js/jquery/ui/effect$suffix.js", array( 'jquery' ), '1.13.2', 1 );
@@ -882 +890 @@
     $scripts->add( 'jquery-ui-sortable', "/wp-includes/js/jquery/ui/sortable$suffix.js", array( 'jquery-ui-mouse' ), '1.13.2', 1 );
 
-    // As of 1.12.1 `jquery-ui-position` and `jquery-ui-widget` are part of `jquery-ui-core`.
-    // Listed here for back-compat.
+    /*
+     * As of 1.12.1 `jquery-ui-position` and `jquery-ui-widget` are part of `jquery-ui-core`.
+     * Listed here for back-compat.
+     */
     $scripts->add( 'jquery-ui-position', false, array( 'jquery-ui-core' ), '1.13.2', 1 );
     $scripts->add( 'jquery-ui-widget', false, array( 'jquery-ui-core' ), '1.13.2', 1 );
@@ -916 +926 @@
     $scripts->add( 'suggest', "/wp-includes/js/jquery/suggest$suffix.js", array( 'jquery' ), '1.1-20110113', 1 );
 
-    // Masonry v2 depended on jQuery. v3 does not. The older jquery-masonry handle is a shiv.
-    // It sets jQuery as a dependency, as the theme may have been implicitly loading it this way.
+    /*
+     * Masonry v2 depended on jQuery. v3 does not. The older jquery-masonry handle is a shiv.
+     * It sets jQuery as a dependency, as the theme may have been implicitly loading it this way.
+     */
     $scripts->add( 'imagesloaded', '/wp-includes/js/imagesloaded.min.js', array(), '4.1.4', 1 );
     $scripts->add( 'masonry', '/wp-includes/js/masonry.min.js', array( 'imagesloaded' ), '4.2.2', 1 );
@@ -1339 +1351 @@
     $scripts->add( 'wp-embed', "/wp-includes/js/wp-embed$suffix.js", array(), false, 1 );
 
-    // To enqueue media-views or media-editor, call wp_enqueue_media().
-    // Both rely on numerous settings, styles, and templates to operate correctly.
+    /*
+     * To enqueue media-views or media-editor, call wp_enqueue_media().
+     * Both rely on numerous settings, styles, and templates to operate correctly.
+     */
     $scripts->add( 'media-views', "/wp-includes/js/media-views$suffix.js", array( 'utils', 'media-models', 'wp-plupload', 'jquery-ui-sortable', 'wp-mediaelement', 'wp-api-request', 'wp-a11y', 'clipboard' ), false, 1 );
     $scripts->set_translations( 'media-views' );
@@ -1636 +1650 @@
         'wp-components',
         'wp-editor',
-        // This need to be added before the block library styles,
-        // The block library styles override the "reset" styles.
+        /*
+         * This needs to be added before the block library styles,
+         * The block library styles override the "reset" styles.
+         */
         'wp-reset-editor-styles',
         'wp-block-library',
@@ -2715 +2731 @@
     $attributes_string    = '';
 
-    // If HTML5 script tag is supported, only the attribute name is added
-    // to $attributes_string for entries with a boolean value, and that are true.
+    /*
+     * If HTML5 script tag is supported, only the attribute name is added
+     * to $attributes_string for entries with a boolean value, and that are true.
+     */
     foreach ( $attributes as $attribute_name => $attribute_value ) {
         if ( is_bool( $attribute_value ) ) {
@@ -2897 +2915 @@
             $style['css'] = file_get_contents( $style['path'] );
 
-            // Check if the style contains relative URLs that need to be modified.
-            // URLs relative to the stylesheet's path should be converted to relative to the site's root.
+            /*
+             * Check if the style contains relative URLs that need to be modified.
+             * URLs relative to the stylesheet's path should be converted to relative to the site's root.
+             */
             $style['css'] = _wp_normalize_relative_css_links( $style['css'], $style['src'] );
 
@@ -3711 +3731 @@
     $classic_theme_styles = ABSPATH . WPINC . "/css/classic-themes$suffix.css";
 
-    // This follows the pattern of get_block_editor_theme_styles,
-    // but we can't use get_block_editor_theme_styles directly as it
-    // only handles external files or theme files.
+    /*
+     * This follows the pattern of get_block_editor_theme_styles,
+     * but we can't use get_block_editor_theme_styles directly as it
+     * only handles external files or theme files.
+     */
     $classic_theme_styles_settings = array(
         'css'            => file_get_contents( $classic_theme_styles ),