WordPress.org
Get WordPress

Make WordPress Core

Changeset 58419


Ignore:
Timestamp:
06/15/2024 12:32:35 PM (3 months 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:
15 edited

Legend:

Unmodified
Added
Removed

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

    r55917 r58419  
    1515 * In case admin-header.php is included in a function.
    1616 *
    17  * @global string    $title
     17 * @global string    $title              The title of the current screen.
    1818 * @global string    $hook_suffix
    1919 * @global WP_Screen $current_screen     WordPress current screen object.

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

    r58029 r58419  
    1313
    1414/**
    15  * @global string       $post_type
    16  * @global WP_Post_Type $post_type_object
     15 * @global string       $post_type        Global post type.
     16 * @global WP_Post_Type $post_type_object Global post type object.
    1717 * @global WP_Post      $post             Global post object.
    1818 */

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

    r56675 r58419  
    1515
    1616/**
    17  * @global string       $post_type
    18  * @global WP_Post_Type $post_type_object
     17 * @global string       $post_type        Global post type.
     18 * @global WP_Post_Type $post_type_object Global post type object.
    1919 * @global WP_Post      $post             Global post object.
    20  * @global string       $title
    21  * @global array        $wp_meta_boxes
     20 * @global string       $title            The title of the current screen.
     21 * @global array        $wp_meta_boxes    Global meta box state.
    2222 */
    2323global $post_type, $post_type_object, $post, $title, $wp_meta_boxes;

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

    r56600 r58419  
    3333
    3434/**
    35  * $post_type is set when the WP_Terms_List_Table instance is created
     35 * $post_type is set when the WP_Terms_List_Table instance is created.
    3636 *
    37  * @global string $post_type
     37 * @global string $post_type Global post type.
    3838 */
    3939global $post_type;

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

    r56606 r58419  
    3030
    3131/**
    32  * @global string       $post_type
    33  * @global WP_Post_Type $post_type_object
     32 * @global string       $post_type        Global post type.
     33 * @global WP_Post_Type $post_type_object Global post type object.
    3434 */
    3535global $post_type, $post_type_object;

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

    r56665 r58419  
    6666     * @see WP_List_Table::__construct() for more information on default arguments.
    6767     *
    68      * @global WP_Post_Type $post_type_object
     68     * @global WP_Post_Type $post_type_object Global post type object.
    6969     * @global wpdb         $wpdb             WordPress database abstraction object.
    7070     *

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

    r57272 r58419  
    985985
    986986    /**
    987      * @global array $wp_meta_boxes
     987     * @global array $wp_meta_boxes Global meta box state.
    988988     *
    989989     * @return bool
    … …  
    11041104     * @since 4.4.0
    11051105     *
    1106      * @global array $wp_meta_boxes
     1106     * @global array $wp_meta_boxes Global meta box state.
    11071107     */
    11081108    public function render_meta_boxes_preferences() {

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

    r56665 r58419  
    2828     * @see WP_List_Table::__construct() for more information on default arguments.
    2929     *
    30      * @global string $post_type
    31      * @global string $taxonomy
     30     * @global string $post_type Global post type.
     31     * @global string $taxonomy  Global taxonomy.
    3232     * @global string $action
    3333     * @global object $tax
    … …  
    331331
    332332    /**
    333      * @global string $taxonomy
     333     * @global string $taxonomy Global taxonomy.
     334     *
    334335     * @param WP_Term $tag   Term object.
    335336     * @param int     $level

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

    r57648 r58419  
    205205 * @since 3.0.0
    206206 *
    207  * @global array $wp_meta_boxes
     207 * @global array $wp_meta_boxes Global meta box state.
    208208 */
    209209function wp_initial_nav_menu_meta_boxes() {

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

    r58067 r58419  
    20312031 * @since 1.5.0
    20322032 *
    2033  * @global string $title
     2033 * @global string $title       The title of the current screen.
    20342034 * @global array  $menu
    20352035 * @global array  $submenu

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

    r58406 r58419  
    23462346 * @global WP_Post   $post           Global post object.
    23472347 * @global WP_Screen $current_screen WordPress current screen object.
    2348  * @global array     $wp_meta_boxes
     2348 * @global array     $wp_meta_boxes  Global meta box state.
    23492349 */
    23502350function the_block_editor_meta_boxes() {

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

    r50832 r58419  
    9090 * @since 2.7.0
    9191 *
    92  * @global array $wp_meta_boxes
     92 * @global array $wp_meta_boxes Global meta box state.
    9393 *
    9494 * @param WP_Screen $screen

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

    r57181 r58419  
    10511051 * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs.
    10521052 *
    1053  * @global array $wp_meta_boxes
     1053 * @global array $wp_meta_boxes Global meta box state.
    10541054 *
    10551055 * @param string                 $id            Meta box ID (used in the 'id' attribute for the meta box).
    … …  
    12881288 * @since 2.5.0
    12891289 *
    1290  * @global array $wp_meta_boxes
     1290 * @global array $wp_meta_boxes Global meta box state.
    12911291 *
    12921292 * @param string|WP_Screen $screen      The screen identifier. If you have used add_menu_page() or
    … …  
    14731473 * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs.
    14741474 *
    1475  * @global array $wp_meta_boxes
     1475 * @global array $wp_meta_boxes Global meta box state.
    14761476 *
    14771477 * @param string                 $id      Meta box ID (used in the 'id' attribute for the meta box).

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

    r47808 r58419  
    1111
    1212/**
    13  * @global string  $post_type
    14  * @global object  $post_type_object
    15  * @global WP_Post $post             Global post object.
     13 * @global string       $post_type        Global post type.
     14 * @global WP_Post_Type $post_type_object Global post type object.
     15 * @global WP_Post      $post             Global post object.
    1616 */
    1717global $post_type, $post_type_object, $post;

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

    r58069 r58419  
    2929
    3030/**
    31  * @global string  $post_type
    32  * @global object  $post_type_object
    33  * @global WP_Post $post             Global post object.
     31 * @global string       $post_type        Global post type.
     32 * @global WP_Post_Type $post_type_object Global post type object.
     33 * @global WP_Post      $post             Global post object.
    3434 */
    3535global $post_type, $post_type_object, $post;
Note: See TracChangeset for help on using the changeset viewer.