WordPress.org

Make WordPress Core

Changeset 46591


Ignore:
Timestamp:
10/26/2019 12:34:10 AM (2 years ago)
Author:
SergeyBiryukov
Message:

Docs: Improve formatting of various WP_Screen DocBlocks.

See #48303.

File:
1 edited

Legend:

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

    r46590 r46591  
    1515final class WP_Screen {
    1616    /**
    17      * Any action associated with the screen. 'add' for *-add.php and *-new.php screens. Empty otherwise.
     17     * Any action associated with the screen.
     18     *
     19     * 'add' for *-add.php and *-new.php screens. Empty otherwise.
    1820     *
    1921     * @since 3.3.0
     
    2325
    2426    /**
    25      * The base type of the screen. This is typically the same as $id but with any post types and taxonomies stripped.
    26      * For example, for an $id of 'edit-post' the base is 'edit'.
     27     * The base type of the screen.
     28     *
     29     * This is typically the same as `$id` but with any post types and taxonomies stripped.
     30     * For example, for an `$id` of 'edit-post' the base is 'edit'.
    2731     *
    2832     * @since 3.3.0
     
    7983    /**
    8084     * The base menu parent.
    81      * This is derived from $parent_file by removing the query string and any .php extension.
    82      * $parent_file values of 'edit.php?post_type=page' and 'edit.php?post_type=post' have a $parent_base of 'edit'.
     85     *
     86     * This is derived from `$parent_file` by removing the query string and any .php extension.
     87     * `$parent_file` values of 'edit.php?post_type=page' and 'edit.php?post_type=post'
     88     * have a `$parent_base` of 'edit'.
    8389     *
    8490     * @since 3.3.0
     
    8995    /**
    9096     * The parent_file for the screen per the admin menu system.
    91      * Some $parent_file values are 'edit.php?post_type=page', 'edit.php', and 'options-general.php'.
     97     *
     98     * Some `$parent_file` values are 'edit.php?post_type=page', 'edit.php', and 'options-general.php'.
    9299     *
    93100     * @since 3.3.0
     
    98105    /**
    99106     * The post type associated with the screen, if any.
     107     *
    100108     * The 'edit.php?post_type=page' screen has a post type of 'page'.
    101109     * The 'edit-tags.php?taxonomy=$taxonomy&post_type=page' screen has a post type of 'page'.
     
    108116    /**
    109117     * The taxonomy associated with the screen, if any.
     118     *
    110119     * The 'edit-tags.php?taxonomy=category' screen has a taxonomy of 'category'.
    111120     *
     
    467476    /**
    468477     * Set the parent information for the screen.
     478     *
    469479     * This is called in admin-header.php after the menu parent for the screen has been determined.
    470480     *
     
    481491    /**
    482492     * Adds an option for the screen.
    483      * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add screen options.
     493     *
     494     * Call this in template files after admin.php is loaded and before admin-header.php is loaded
     495     * to add screen options.
    484496     *
    485497     * @since 3.3.0
     
    671683    /**
    672684     * Add a sidebar to the contextual help for the screen.
    673      * Call this in template files after admin.php is loaded and before admin-header.php is loaded to add a sidebar to the contextual help.
     685     *
     686     * Call this in template files after admin.php is loaded and before admin-header.php is loaded
     687     * to add a sidebar to the contextual help.
    674688     *
    675689     * @since 3.3.0
Note: See TracChangeset for help on using the changeset viewer.