Changeset 57181

Timestamp:

12/11/2023 12:09:42 PM (17 months ago)

Author:

SergeyBiryukov

Message:

Docs: Consistently document the $body_id global as a string.

Includes declaring the global at the beginning of wp_iframe() and iframe_header().

Follow-up to [32642], [32643].

Props mukesh27, upadalavipul.
Fixes #60032.

Location:

trunk/src/wp-admin/includes

Files:

• media.php (modified) (3 diffs)
• template.php (modified) (3 diffs)

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

@@ -528 +528 @@
  *              by adding it to the function signature.
  *
- * @global int $body_id
+ * @global string $body_id
  *
  * @param callable $content_func Function that outputs the content.
@@ -534 +534 @@
  */
 function wp_iframe( $content_func, ...$args ) {
+    global $body_id;
+
     _wp_admin_html_begin();
     ?>
@@ -604 +606 @@
     $body_id_attr = '';
 
-    if ( isset( $GLOBALS['body_id'] ) ) {
-        $body_id_attr = ' id="' . $GLOBALS['body_id'] . '"';
+    if ( isset( $body_id ) ) {
+        $body_id_attr = ' id="' . $body_id . '"';
     }
 

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

@@ -2119 +2119 @@
  * @global string    $hook_suffix
  * @global string    $admin_body_class
+ * @global string    $body_id
  * @global WP_Locale $wp_locale        WordPress date and time locale object.
  *
@@ -2125 +2126 @@
  */
 function iframe_header( $title = '', $deprecated = false ) {
+    global $hook_suffix, $admin_body_class, $body_id, $wp_locale;
+
     show_admin_bar( false );
-    global $hook_suffix, $admin_body_class, $wp_locale;
+
     $admin_body_class = preg_replace( '/[^a-z0-9_-]+/i', '-', $hook_suffix );
 
@@ -2180 +2183 @@
 </head>
     <?php
-    /**
-     * @global string $body_id
-     */
-    $admin_body_id = isset( $GLOBALS['body_id'] ) ? 'id="' . $GLOBALS['body_id'] . '" ' : '';
+    $admin_body_id = isset( $body_id ) ? 'id="' . $body_id . '" ' : '';
 
     /** This filter is documented in wp-admin/admin-header.php */