Changeset 51942 for trunk

Timestamp:

10/27/2021 06:20:58 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document the usage of some globals in wp-includes/script-loader.php.

Follow-up to [44114], [44262], [49080], [50761], [51471].

See #53399.

File:

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

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

@@ -40 +40 @@
  * @since 5.0.0
  *
+ * @global string $tinymce_version
+ * @global bool   $concatenate_scripts
+ * @global bool   $compress_scripts
+ *
  * @param WP_Scripts $scripts            WP_Scripts object.
  * @param bool       $force_uncompressed Whether to forcibly prevent gzip compression. Default false.
@@ -45 +49 @@
 function wp_register_tinymce_scripts( $scripts, $force_uncompressed = false ) {
     global $tinymce_version, $concatenate_scripts, $compress_scripts;
+
     $suffix     = wp_scripts_get_suffix();
     $dev_suffix = wp_scripts_get_suffix( 'dev' );
@@ -72 +77 @@
  *
  * @since 5.0.0
+ *
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @param WP_Scripts $scripts WP_Scripts object.
@@ -277 +284 @@
  *
  * @since 5.0.0
+ *
+ * @global WP_Locale $wp_locale WordPress date and time locale object.
  *
  * @param WP_Scripts $scripts WP_Scripts object.
@@ -1380 +1389 @@
  * @since 2.6.0
  *
+ * @global array $editor_styles
+ *
  * @param WP_Styles $styles
  */
 function wp_default_styles( $styles ) {
+    global $editor_styles;
+
     // Include an unmodified $wp_version.
     require ABSPATH . WPINC . '/version.php';
@@ -1535 +1548 @@
     }
 
-    global $editor_styles;
     if ( ! is_array( $editor_styles ) || count( $editor_styles ) === 0 ) {
         // Include opinionated block styles if no $editor_styles are declared, so the editor never appears broken.
@@ -2033 +2045 @@
  */
 function wp_print_head_scripts() {
+    global $wp_scripts;
+
     if ( ! did_action( 'wp_print_scripts' ) ) {
         /** This action is documented in wp-includes/functions.wp-scripts.php */
@@ -2038 +2052 @@
     }
 
-    global $wp_scripts;
-
     if ( ! ( $wp_scripts instanceof WP_Scripts ) ) {
         return array(); // No need to run if nothing is queued.
     }
+
     return print_head_scripts();
 }
@@ -2244 +2257 @@
  *
  * @since 5.0.0
- *
- * @global WP_Screen $current_screen WordPress current screen object.
  */
 function wp_common_block_scripts_and_styles() {
@@ -2333 +2344 @@
  *
  * @since 5.6.0
+ *
+ * @global WP_Screen $current_screen WordPress current screen object.
  *
  * @return bool Whether scripts and styles should be enqueued.
@@ -2437 +2450 @@
  *
  * @since 5.3.0
+ *
+ * @global WP_Styles $wp_styles
  */
 function enqueue_block_styles_assets() {
+    global $wp_styles;
+
     $block_styles = WP_Block_Styles_Registry::get_instance()->get_all_registered();
 
@@ -2466 +2483 @@
                 if ( wp_should_load_separate_core_block_assets() ) {
                     $block_stylesheet_handle = generate_block_asset_handle( $block_name, 'style' );
-                    global $wp_styles;
+
                     if ( isset( $wp_styles->registered[ $block_stylesheet_handle ] ) ) {
                         $handle = $block_stylesheet_handle;