Changeset 54831

Timestamp:

11/13/2022 01:49:16 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document the usage of globals in some functions.

This affects:

• the_block_editor_meta_boxes()
• wp_generate_block_templates_export_file()
• WP_oEmbed_Controller::get_proxy_item()

Follow-up to [44131], [48135], [51151], [53129].

Props krunal265.
Fixes #57082.

Location:

trunk/src

Files:

• wp-admin/includes/post.php (modified) (1 diff)
• wp-includes/block-template-utils.php (modified) (2 diffs)
• wp-includes/class-wp-oembed-controller.php (modified) (3 diffs)

trunk/src/wp-admin/includes/post.php

@@ -2211 +2211 @@
  *
  * @since 5.0.0
+ *
+ * @global WP_Post   $post           Global post object.
+ * @global WP_Screen $current_screen WordPress current screen object.
+ * @global array     $wp_meta_boxes
  */
 function the_block_editor_meta_boxes() {

trunk/src/wp-includes/block-template-utils.php

@@ -1201 +1201 @@
  * @since 6.0.0 Adds the whole theme to the export archive.
  *
+ * @global string $wp_version The WordPress version string.
+ *
  * @return WP_Error|string Path of the ZIP file or error on failure.
  */
 function wp_generate_block_templates_export_file() {
+    global $wp_version;
+
     if ( ! class_exists( 'ZipArchive' ) ) {
         return new WP_Error( 'missing_zip_package', __( 'Zip Export not supported.' ) );
@@ -1271 +1275 @@
     // If a version is defined, add a schema.
     if ( $theme_json_raw['version'] ) {
-        global $wp_version;
         $theme_json_version = 'wp/' . substr( $wp_version, 0, 3 );
         $schema             = array( '$schema' => 'https://schemas.wp.org/' . $theme_json_version . '/theme.json' );

trunk/src/wp-includes/class-wp-oembed-controller.php

@@ -161 +161 @@
      *
      * @see WP_oEmbed::get_html()
-     * @global WP_Embed $wp_embed
+     * @global WP_Embed   $wp_embed
+     * @global WP_Scripts $wp_scripts
      *
      * @param WP_REST_Request $request Full data about the request.
@@ -167 +168 @@
      */
     public function get_proxy_item( $request ) {
-        global $wp_embed;
+        global $wp_embed, $wp_scripts;
 
         $args = $request->get_params();
@@ -205 +206 @@
 
             if ( $html ) {
-                global $wp_scripts;
                 // Check if any scripts were enqueued by the shortcode, and include them in the response.
                 $enqueued_scripts = array();