Make WordPress Core

Changeset 48941


Ignore:
Timestamp:
09/04/2020 08:39:47 PM (3 years ago)
Author:
johnbillion
Message:

Docs: Various docblock corrections and improvements.

See #50768

Location:
trunk/src
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-comments-list-table.php

    r48741 r48941  
    473473
    474474    /**
    475      * Displays a comment status drop-down for filtering on the Comments list table.
     475     * Displays a comment type drop-down for filtering on the Comments list table.
    476476     *
    477477     * @since 5.5.0
     
    481481    protected function comment_status_dropdown( $comment_type ) {
    482482        /**
    483          * Filters the comment types dropdown menu.
     483         * Filters the comment types shown in the drop-down menu on the Comments list table.
    484484         *
    485485         * @since 2.7.0
    486486         *
    487          * @param array $comment_types An array of comment types. Accepts 'Comments', 'Pings'.
     487         * @param string[] $comment_types Array of comment type labels keyed by their name.
    488488         */
    489489        $comment_types = apply_filters(
  • trunk/src/wp-admin/media-upload.php

    r47785 r48941  
    7474     * @since 2.5.0
    7575     *
    76      * @param string $type The default media popup tab. Default 'type' (From Computer).
     76     * @param string $tab The default media popup tab. Default 'type' (From Computer).
    7777     */
    7878    $tab = apply_filters( 'media_upload_default_tab', 'type' );
  • trunk/src/wp-includes/category-template.php

    r48623 r48941  
    11541154 *
    11551155 * @param int $post_id Post ID.
    1156  * @return array|false|WP_Error Array of tag objects on success, false on failure.
     1156 * @return WP_Term[]|false|WP_Error Array of WP_Term objects on success, false if there are no terms
     1157 *                                  or the post does not exist, WP_Error on failure.
    11571158 */
    11581159function get_the_tags( $post_id = 0 ) {
     
    11661167     * @see get_the_terms()
    11671168     *
    1168      * @param WP_Term[] $terms An array of tags for the given post.
     1169     * @param WP_Term[]|false|WP_Error $terms Array of WP_Term objects on success, false if there are no terms
     1170     *                                        or the post does not exist, WP_Error on failure.
    11691171     */
    11701172    return apply_filters( 'get_the_tags', $terms );
  • trunk/src/wp-includes/class-wp-comment.php

    r47597 r48941  
    1818     * Comment ID.
    1919     *
    20      * @since 4.4.0
    21      * @var int
     20     * A numeric string, for compatibility reasons.
     21     *
     22     * @since 4.4.0
     23     * @var string
    2224     */
    2325    public $comment_ID;
     
    2628     * ID of the post the comment is associated with.
    2729     *
    28      * @since 4.4.0
    29      * @var int
     30     * A numeric string, for compatibility reasons.
     31     *
     32     * @since 4.4.0
     33     * @var string
    3034     */
    3135    public $comment_post_ID = 0;
     
    9094     * Comment karma count.
    9195     *
    92      * @since 4.4.0
    93      * @var int
     96     * A numeric string, for compatibility reasons.
     97     *
     98     * @since 4.4.0
     99     * @var string
    94100     */
    95101    public $comment_karma = 0;
     
    123129     * Parent comment ID.
    124130     *
    125      * @since 4.4.0
    126      * @var int
     131     * A numeric string, for compatibility reasons.
     132     *
     133     * @since 4.4.0
     134     * @var string
    127135     */
    128136    public $comment_parent = 0;
     
    131139     * Comment author ID.
    132140     *
    133      * @since 4.4.0
    134      * @var int
     141     * A numeric string, for compatibility reasons.
     142     *
     143     * @since 4.4.0
     144     * @var string
    135145     */
    136146    public $user_id = 0;
  • trunk/src/wp-includes/class-wp-post.php

    r44914 r48941  
    1515 * @property string $page_template
    1616 *
    17  * @property-read array  $ancestors
     17 * @property-read int[]  $ancestors
    1818 * @property-read int    $post_category
    1919 * @property-read string $tag_input
  • trunk/src/wp-includes/load.php

    r48895 r48941  
    135135 * or a constant of the same name.
    136136 *
    137  * Possible values include 'local', 'development', 'staging', 'production'.
     137 * Possible values are 'local', 'development', 'staging', and 'production'.
    138138 * If not set, the type defaults to 'production'.
    139139 *
  • trunk/src/wp-includes/post.php

    r48829 r48941  
    797797
    798798/**
    799  * Retrieve ancestors of a post.
     799 * Retrieves the IDs of the ancestors of a post.
    800800 *
    801801 * @since 2.5.0
    802802 *
    803803 * @param int|WP_Post $post Post ID or post object.
    804  * @return int[] Ancestor IDs or empty array if none are found.
     804 * @return int[] Array of ancestor IDs or empty array if there are none.
    805805 */
    806806function get_post_ancestors( $post ) {
  • trunk/src/wp-includes/taxonomy.php

    r48843 r48941  
    887887     * Filters a taxonomy term object.
    888888     *
     889     * The {@see 'get_$taxonomy'} hook is also available for targeting a specific
     890     * taxonomy.
     891     *
    889892     * @since 2.3.0
    890893     * @since 4.4.0 `$_term` is now a `WP_Term` object.
     
    19871990     * Fires after a term is deleted from the database and the cache is cleaned.
    19881991     *
     1992     * The {@see 'delete_$taxonomy'} hook is also available for targeting a specific
     1993     * taxonomy.
     1994     *
    19891995     * @since 2.5.0
    19901996     * @since 4.5.0 Introduced the `$object_ids` argument.
     
    19931999     * @param int     $tt_id        Term taxonomy ID.
    19942000     * @param string  $taxonomy     Taxonomy slug.
    1995      * @param mixed   $deleted_term Copy of the already-deleted term, in the form specified
    1996      *                              by the parent function. WP_Error otherwise.
     2001     * @param WP_Term $deleted_term Copy of the already-deleted term.
    19972002     * @param array   $object_ids   List of term object IDs.
    19982003     */
     
    20102015     * @param int     $term         Term ID.
    20112016     * @param int     $tt_id        Term taxonomy ID.
    2012      * @param mixed   $deleted_term Copy of the already-deleted term, in the form specified
    2013      *                              by the parent function. WP_Error otherwise.
     2017     * @param WP_Term $deleted_term Copy of the already-deleted term.
    20142018     * @param array   $object_ids   List of term object IDs.
    20152019     */
     
    21822186 * @param string       $taxonomy The taxonomy to which to add the term.
    21832187 * @param array|string $args {
    2184  *     Optional. Array or string of arguments for inserting a term.
     2188 *     Optional. Array or query string of arguments for inserting a term.
    21852189 *
    21862190 *     @type string $alias_of    Slug of the term to make this term an alias of.
     
    31053109
    31063110    /**
    3107      * Fires immediately after the given terms are edited.
     3111     * Fires immediately after a term is updated in the database, but before its
     3112     * term-taxonomy relationship is updated.
    31083113     *
    31093114     * @since 2.9.0
     
    31383143    /**
    31393144     * Fires after a term has been updated, but before the term cache has been cleaned.
     3145     *
     3146     * The {@see 'edit_$taxonomy'} hook is also available for targeting a specific
     3147     * taxonomy.
    31403148     *
    31413149     * @since 2.3.0
     
    31673175    /**
    31683176     * Fires after a term has been updated, and the term cache has been cleaned.
     3177     *
     3178     * The {@see 'edited_$taxonomy'} hook is also available for targeting a specific
     3179     * taxonomy.
    31693180     *
    31703181     * @since 2.3.0
Note: See TracChangeset for help on using the changeset viewer.