Changeset 58419

Timestamp:

06/15/2024 12:32:35 PM (6 weeks ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing description for a few globals in the admin.

This affects:

• $post_type
• $post_type_object
• $taxonomy
• $title
• $wp_meta_boxes

Follow-up to [31121], [32642], [32643], [37890], [43815], [44244], [45742], [53060], [53061], [54831].

Props shub07, 1naveengiri, sabernhardt, SergeyBiryukov.
Fixes #59561.

Location:

trunk/src/wp-admin

Files:

• admin-header.php (modified) (1 diff)
• edit-form-advanced.php (modified) (1 diff)
• edit-form-blocks.php (modified) (1 diff)
• edit-tags.php (modified) (1 diff)
• edit.php (modified) (1 diff)
• includes/class-wp-posts-list-table.php (modified) (1 diff)
• includes/class-wp-screen.php (modified) (2 diffs)
• includes/class-wp-terms-list-table.php (modified) (2 diffs)
• includes/nav-menu.php (modified) (1 diff)
• includes/plugin.php (modified) (1 diff)
• includes/post.php (modified) (1 diff)
• includes/screen.php (modified) (1 diff)
• includes/template.php (modified) (3 diffs)
• post-new.php (modified) (1 diff)
• post.php (modified) (1 diff)

trunk/src/wp-admin/admin-header.php

@@ -15 +15 @@
  * In case admin-header.php is included in a function.
  *
- * @global string    $title
+ * @global string    $title
  * @global string    $hook_suffix
  * @global WP_Screen $current_screen     WordPress current screen object.

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

@@ -13 +13 @@
 
 /**
- * @global string       $post_type
- * @global WP_Post_Type $post_type_object
+ * @global string       $post_type
+ * @global WP_Post_Type $post_type_object
  * @global WP_Post      $post             Global post object.
  */

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

@@ -15 +15 @@
 
 /**
- * @global string       $post_type
- * @global WP_Post_Type $post_type_object
+ * @global string       $post_type
+ * @global WP_Post_Type $post_type_object
  * @global WP_Post      $post             Global post object.
- * @global string       $title
- * @global array        $wp_meta_boxes
+ * @global string       $title
+ * @global array        $wp_meta_boxes
  */
 global $post_type, $post_type_object, $post, $title, $wp_meta_boxes;

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

@@ -33 +33 @@
 
 /**
- * $post_type is set when the WP_Terms_List_Table instance is created
+ * $post_type is set when the WP_Terms_List_Table instance is created
  *
- * @global string $post_type
+ * @global string $post_type
  */
 global $post_type;

trunk/src/wp-admin/edit.php

@@ -30 +30 @@
 
 /**
- * @global string       $post_type
- * @global WP_Post_Type $post_type_object
+ * @global string       $post_type
+ * @global WP_Post_Type $post_type_object
  */
 global $post_type, $post_type_object;

trunk/src/wp-admin/includes/class-wp-posts-list-table.php

@@ -66 +66 @@
      * @see WP_List_Table::__construct() for more information on default arguments.
      *
-     * @global WP_Post_Type $post_type_object
+     * @global WP_Post_Type $post_type_object
      * @global wpdb         $wpdb             WordPress database abstraction object.
      *

trunk/src/wp-admin/includes/class-wp-screen.php

@@ -985 +985 @@
 
     /**
-     * @global array $wp_meta_boxes
+     * @global array $wp_meta_boxes
      *
      * @return bool
@@ -1104 +1104 @@
      * @since 4.4.0
      *
-     * @global array $wp_meta_boxes
+     * @global array $wp_meta_boxes
      */
     public function render_meta_boxes_preferences() {

trunk/src/wp-admin/includes/class-wp-terms-list-table.php

@@ -28 +28 @@
      * @see WP_List_Table::__construct() for more information on default arguments.
      *
-     * @global string $post_type
-     * @global string $taxonomy
+     * @global string $post_type
+     * @global string $taxonomy
      * @global string $action
      * @global object $tax
@@ -331 +331 @@
 
     /**
-     * @global string $taxonomy
+     * @global string $taxonomy Global taxonomy.
+     *
      * @param WP_Term $tag   Term object.
      * @param int     $level

trunk/src/wp-admin/includes/nav-menu.php

@@ -205 +205 @@
  * @since 3.0.0
  *
- * @global array $wp_meta_boxes
+ * @global array $wp_meta_boxes
  */
 function wp_initial_nav_menu_meta_boxes() {

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

@@ -2031 +2031 @@
  * @since 1.5.0
  *
- * @global string $title
+ * @global string $title
  * @global array  $menu
  * @global array  $submenu

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

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

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

@@ -90 +90 @@
  * @since 2.7.0
  *
- * @global array $wp_meta_boxes
+ * @global array $wp_meta_boxes
  *
  * @param WP_Screen $screen

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

@@ -1051 +1051 @@
  * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs.
  *
- * @global array $wp_meta_boxes
+ * @global array $wp_meta_boxes
  *
  * @param string                 $id            Meta box ID (used in the 'id' attribute for the meta box).
@@ -1288 +1288 @@
  * @since 2.5.0
  *
- * @global array $wp_meta_boxes
+ * @global array $wp_meta_boxes
  *
  * @param string|WP_Screen $screen      The screen identifier. If you have used add_menu_page() or
@@ -1473 +1473 @@
  * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs.
  *
- * @global array $wp_meta_boxes
+ * @global array $wp_meta_boxes
  *
  * @param string                 $id      Meta box ID (used in the 'id' attribute for the meta box).

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

@@ -11 +11 @@
 
 /**
- * @global string  $post_type
- * @global object  $post_type_object
- * @global WP_Post $post             Global post object.
+ * @global string  
+ * @global 
+ * @global WP_Post $post             Global post object.
  */
 global $post_type, $post_type_object, $post;

trunk/src/wp-admin/post.php

@@ -29 +29 @@
 
 /**
- * @global string  $post_type
- * @global object  $post_type_object
- * @global WP_Post $post             Global post object.
+ * @global string  
+ * @global 
+ * @global WP_Post $post             Global post object.
  */
 global $post_type, $post_type_object, $post;