Changeset 53450

Timestamp:

05/29/2022 03:33:12 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Docs: Explicitly declare some globals for clarity.

This aims to improve developer experience by making it clear that these variables are defined elsewhere.

Props ravipatel, davidbaumwald, hellofromTonya, costdev, SergeyBiryukov.
Fixes #51439.

Location:

trunk/src/wp-admin

Files:

• edit-comments.php (modified) (2 diffs)
• edit-form-comment.php (modified) (2 diffs)
• edit.php (modified) (2 diffs)
• install.php (modified) (1 diff)
• upgrade.php (modified) (1 diff)

trunk/src/wp-admin/edit-comments.php

@@ -26 +26 @@
 
     if ( 'delete_all' === $doaction && ! empty( $_REQUEST['pagegen_timestamp'] ) ) {
+        /**
+         * @global wpdb $wpdb WordPress database abstraction object.
+         */
+        global $wpdb;
+
         $comment_status = wp_unslash( $_REQUEST['comment_status'] );
         $delete_time    = wp_unslash( $_REQUEST['pagegen_timestamp'] );
@@ -135 +140 @@
 wp_enqueue_script( 'admin-comments' );
 enqueue_comment_hotkeys_js();
+
+/**
+ * @global int $post_id
+ */
+global $post_id;
 
 if ( $post_id ) {

trunk/src/wp-admin/edit-form-comment.php

@@ -11 +11 @@
     die( '-1' );
 }
+
+/**
+ * @global WP_Comment $comment Global comment object.
+ */
+global $comment;
 ?>
 <form name="post" action="comment.php" method="post" id="post">
@@ -140 +145 @@
 <fieldset id='timestampdiv' class='hide-if-js'>
 <legend class="screen-reader-text"><?php _e( 'Date and time' ); ?></legend>
-<?php touch_time( ( 'editcomment' === $action ), 0 ); ?>
+<?php
+/**
+ * @global string $action
+ */
+global $action;
+
+touch_time( ( 'editcomment' === $action ), 0 );
+?>
 </fieldset>
 </div>

trunk/src/wp-admin/edit.php

@@ -9 +9 @@
 /** WordPress Administration Bootstrap */
 require_once __DIR__ . '/admin.php';
+
+/**
+ * @global string $typenow The post type of the current screen.
+ */
+global $typenow;
 
 if ( ! $typenow ) {
@@ -88 +93 @@
         // Validate the post status exists.
         if ( get_post_status_object( $post_status ) ) {
+            /**
+             * @global wpdb $wpdb WordPress database abstraction object.
+             */
+            global $wpdb;
+
             $post_ids = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_type=%s AND post_status = %s", $post_type, $post_status ) );
         }

trunk/src/wp-admin/install.php

@@ -226 +226 @@
  * @global string $required_php_version   The required PHP version string.
  * @global string $required_mysql_version The required MySQL version string.
- */
-global $wp_version, $required_php_version, $required_mysql_version;
+ * @global wpdb   $wpdb                   WordPress database abstraction object.
+ */
+global $wp_version, $required_php_version, $required_mysql_version, $wpdb;
 
 $php_version   = PHP_VERSION;

trunk/src/wp-admin/upgrade.php

@@ -40 +40 @@
  * @global string $required_php_version   The required PHP version string.
  * @global string $required_mysql_version The required MySQL version string.
+ * @global wpdb   $wpdb                   WordPress database abstraction object.
  */
-global $wp_version, $required_php_version, $required_mysql_version;
+global $wp_version, $required_php_version, $required_mysql_version, $wpdb;
 
 $step = (int) $step;