WordPress.org

Make WordPress Core

Changeset 49183


Ignore:
Timestamp:
10/17/2020 04:03:58 PM (12 months ago)
Author:
johnbillion
Message:

Docs: Fix and upgrade various object docblock notations.

See #50768

Location:
trunk/src
Files:
18 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/edit-tag-form.php

    r47785 r49183  
    139139            <?php
    140140            /**
    141              * Filters the editable slug.
     141             * Filters the editable slug for a post or term.
    142142             *
    143143             * Note: This is a multi-use hook in that it is leveraged both for editable
     
    149149             * @param string          $slug The editable slug. Will be either a term slug or post URI depending
    150150             *                              upon the context in which it is evaluated.
    151              * @param WP_Term|WP_Post $tag  Term or WP_Post object.
     151             * @param WP_Term|WP_Post $tag  Term or post object.
    152152             */
    153153            $slug = isset( $tag->slug ) ? apply_filters( 'editable_slug', $tag->slug, $tag ) : '';
  • trunk/src/wp-admin/includes/class-wp-media-list-table.php

    r48618 r49183  
    803803     * @since 4.3.0
    804804     *
    805      * @param object $post        Attachment being acted upon.
    806      * @param string $column_name Current column name.
    807      * @param string $primary     Primary column name.
     805     * @param WP_Post $post        Attachment being acted upon.
     806     * @param string  $column_name Current column name.
     807     * @param string  $primary     Primary column name.
    808808     * @return string Row actions output for media attachments, or an empty string
    809809     *                if the current column is not the primary column.
  • trunk/src/wp-admin/includes/class-wp-ms-users-list-table.php

    r48595 r49183  
    491491     * @since 4.3.0
    492492     *
    493      * @param object $user        User being acted upon.
    494      * @param string $column_name Current column name.
    495      * @param string $primary     Primary column name.
     493     * @param WP_User $user        User being acted upon.
     494     * @param string  $column_name Current column name.
     495     * @param string  $primary     Primary column name.
    496496     * @return string Row actions output for users in Multisite, or an empty string
    497497     *                if the current column is not the primary column.
  • trunk/src/wp-admin/includes/class-wp-posts-list-table.php

    r49108 r49183  
    13221322     * @since 4.3.0
    13231323     *
    1324      * @param object $post        Post being acted upon.
    1325      * @param string $column_name Current column name.
    1326      * @param string $primary     Primary column name.
     1324     * @param WP_Post $post        Post being acted upon.
     1325     * @param string  $column_name Current column name.
     1326     * @param string  $primary     Primary column name.
    13271327     * @return string Row actions output for posts, or an empty string
    13281328     *                if the current column is not the primary column.
  • trunk/src/wp-admin/includes/export.php

    r49108 r49183  
    228228     * @since 2.1.0
    229229     *
    230      * @param object $category Category Object
     230     * @param WP_Term $category Category Object
    231231     */
    232232    function wxr_cat_name( $category ) {
     
    243243     * @since 2.1.0
    244244     *
    245      * @param object $category Category Object
     245     * @param WP_Term $category Category Object
    246246     */
    247247    function wxr_category_description( $category ) {
     
    258258     * @since 2.3.0
    259259     *
    260      * @param object $tag Tag Object
     260     * @param WP_Term $tag Tag Object
    261261     */
    262262    function wxr_tag_name( $tag ) {
     
    273273     * @since 2.3.0
    274274     *
    275      * @param object $tag Tag Object
     275     * @param WP_Term $tag Tag Object
    276276     */
    277277    function wxr_tag_description( $tag ) {
     
    288288     * @since 2.9.0
    289289     *
    290      * @param object $term Term Object
     290     * @param WP_Term $term Term Object
    291291     */
    292292    function wxr_term_name( $term ) {
     
    303303     * @since 2.9.0
    304304     *
    305      * @param object $term Term Object
     305     * @param WP_Term $term Term Object
    306306     */
    307307    function wxr_term_description( $term ) {
  • trunk/src/wp-admin/includes/media.php

    r49181 r49183  
    22762276 *
    22772277 * @param string       $type
    2278  * @param object       $errors
     2278 * @param array        $errors
    22792279 * @param int|WP_Error $id
    22802280 */
  • trunk/src/wp-admin/includes/meta-boxes.php

    r48991 r49183  
    386386 * @since 3.5.0
    387387 *
    388  * @param object $post
     388 * @param WP_Post $post
    389389 */
    390390function attachment_submit_meta_box( $post ) {
     
    696696 * @since 2.6.0
    697697 *
    698  * @param object $post
     698 * @param WP_Post $post
    699699 */
    700700function post_excerpt_meta_box( $post ) {
     
    718718 * @since 2.6.0
    719719 *
    720  * @param object $post
     720 * @param WP_Post $post
    721721 */
    722722function post_trackback_meta_box( $post ) {
     
    759759 * @since 2.6.0
    760760 *
    761  * @param object $post
     761 * @param WP_Post $post
    762762 */
    763763function post_custom_meta_box( $post ) {
     
    793793 * @since 2.6.0
    794794 *
    795  * @param object $post
     795 * @param WP_Post $post
    796796 */
    797797function post_comment_status_meta_box( $post ) {
     
    841841 * @since 2.8.0
    842842 *
    843  * @param object $post
     843 * @param WP_Post $post
    844844 */
    845845function post_comment_meta_box( $post ) {
     
    882882 * @since 2.6.0
    883883 *
    884  * @param object $post
     884 * @param WP_Post $post
    885885 */
    886886function post_slug_meta_box( $post ) {
     
    899899 * @global int $user_ID
    900900 *
    901  * @param object $post
     901 * @param WP_Post $post
    902902 */
    903903function post_author_meta_box( $post ) {
     
    922922 * @since 2.6.0
    923923 *
    924  * @param object $post
     924 * @param WP_Post $post
    925925 */
    926926function post_revisions_meta_box( $post ) {
     
    937937 * @since 2.7.0
    938938 *
    939  * @param object $post
     939 * @param WP_Post $post
    940940 */
    941941function page_attributes_meta_box( $post ) {
  • trunk/src/wp-content/themes/twentyeleven/functions.php

    r49105 r49183  
    699699     * @since Twenty Eleven 1.0
    700700     *
    701      * @param object $comment The comment object.
    702      * @param array  $args    An array of comment arguments. @see get_comment_reply_link()
    703      * @param int    $depth   The depth of the comment.
     701     * @param WP_Comment $comment The comment object.
     702     * @param array      $args    An array of comment arguments. @see get_comment_reply_link()
     703     * @param int        $depth   The depth of the comment.
    704704     */
    705705    function twentyeleven_comment( $comment, $args, $depth ) {
  • trunk/src/wp-content/themes/twentyeleven/inc/theme-options.php

    r48782 r49183  
    527527 * @since Twenty Eleven 1.3
    528528 *
    529  * @param object $wp_customize Customizer object.
     529 * @param WP_Customize_Manager $wp_customize Customizer object.
    530530 */
    531531function twentyeleven_customize_register( $wp_customize ) {
  • trunk/src/wp-content/themes/twentynineteen/inc/template-functions.php

    r48106 r49183  
    121121 * Add an extra menu to our nav for our priority+ navigation to use
    122122 *
    123  * @param object $nav_menu  Nav menu.
     123 * @param string $nav_menu  Nav menu.
    124124 * @param object $args      Nav menu args.
    125125 * @return string More link for hidden menu items.
  • trunk/src/wp-content/themes/twentyten/functions.php

    r49106 r49183  
    411411     * @since Twenty Ten 1.0
    412412     *
    413      * @param object $comment The comment object.
    414      * @param array  $args    An array of arguments. @see get_comment_reply_link()
    415      * @param int    $depth   The depth of the comment.
     413     * @param WP_Comment $comment The comment object.
     414     * @param array      $args    An array of arguments. @see get_comment_reply_link()
     415     * @param int        $depth   The depth of the comment.
    416416     */
    417417    function twentyten_comment( $comment, $args, $depth ) {
  • trunk/src/wp-includes/class-walker-category-dropdown.php

    r42343 r49183  
    4848     * @see Walker::start_el()
    4949     *
    50      * @param string $output   Used to append additional content (passed by reference).
    51      * @param object $category Category data object.
    52      * @param int    $depth    Depth of category. Used for padding.
    53      * @param array  $args     Uses 'selected', 'show_count', and 'value_field' keys, if they exist.
    54      *                         See wp_dropdown_categories().
    55      * @param int    $id       Optional. ID of the current category. Default 0 (unused).
     50     * @param string  $output   Used to append additional content (passed by reference).
     51     * @param WP_Term $category Category data object.
     52     * @param int     $depth    Depth of category. Used for padding.
     53     * @param array   $args     Uses 'selected', 'show_count', and 'value_field' keys, if they exist.
     54     *                          See wp_dropdown_categories().
     55     * @param int     $id       Optional. ID of the current category. Default 0 (unused).
    5656     */
    5757    public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
  • trunk/src/wp-includes/class-walker-category.php

    r47808 r49183  
    9090     * @see Walker::start_el()
    9191     *
    92      * @param string $output   Used to append additional content (passed by reference).
    93      * @param object $category Category data object.
    94      * @param int    $depth    Optional. Depth of category in reference to parents. Default 0.
    95      * @param array  $args     Optional. An array of arguments. See wp_list_categories(). Default empty array.
    96      * @param int    $id       Optional. ID of the current category. Default 0.
     92     * @param string  $output   Used to append additional content (passed by reference).
     93     * @param WP_Term $category Category data object.
     94     * @param int     $depth    Optional. Depth of category in reference to parents. Default 0.
     95     * @param array   $args     Optional. An array of arguments. See wp_list_categories(). Default empty array.
     96     * @param int     $id       Optional. ID of the current category. Default 0.
    9797     */
    9898    public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
     
    114114             * @since 1.2.0
    115115             *
    116              * @param string $description Category description.
    117              * @param object $category    Category object.
     116             * @param string  $description Category description.
     117             * @param WP_Term $category    Category object.
    118118             */
    119119            $atts['title'] = strip_tags( apply_filters( 'category_description', $category->description, $category ) );
     
    228228             * @see wp_list_categories()
    229229             *
    230              * @param array $css_classes An array of CSS classes to be applied to each list item.
    231              * @param object $category    Category data object.
    232              * @param int    $depth       Depth of page, used for padding.
    233              * @param array  $args        An array of wp_list_categories() arguments.
     230             * @param string[] $css_classes An array of CSS classes to be applied to each list item.
     231             * @param WP_Term $category    Category data object.
     232             * @param int      $depth       Depth of page, used for padding.
     233             * @param array    $args        An array of wp_list_categories() arguments.
    234234             */
    235235            $css_classes = implode( ' ', apply_filters( 'category_css_class', $css_classes, $category, $depth, $args ) );
  • trunk/src/wp-includes/class-wp-xmlrpc-server.php

    r49120 r49183  
    744744     * Prepares taxonomy data for return in an XML-RPC object.
    745745     *
    746      * @param object $taxonomy The unprepared taxonomy data.
    747      * @param array  $fields   The subset of taxonomy fields to return.
     746     * @param WP_Taxonomy $taxonomy The unprepared taxonomy data.
     747     * @param array       $fields   The subset of taxonomy fields to return.
    748748     * @return array The prepared taxonomy data.
    749749     */
     
    10041004     * Prepares media item data for return in an XML-RPC object.
    10051005     *
    1006      * @param object $media_item     The unprepared media item data.
    1007      * @param string $thumbnail_size The image size to use for the thumbnail URL.
     1006     * @param WP_Post $media_item     The unprepared media item data.
     1007     * @param string  $thumbnail_size The image size to use for the thumbnail URL.
    10081008     * @return array The prepared media item data.
    10091009     */
     
    10331033         * @since 3.4.0
    10341034         *
    1035          * @param array  $_media_item    An array of media item data.
    1036          * @param object $media_item     Media item object.
    1037          * @param string $thumbnail_size Image size.
     1035         * @param array   $_media_item    An array of media item data.
     1036         * @param WP_Post $media_item     Media item object.
     1037         * @param string  $thumbnail_size Image size.
    10381038         */
    10391039        return apply_filters( 'xmlrpc_prepare_media_item', $_media_item, $media_item, $thumbnail_size );
     
    10431043     * Prepares page data for return in an XML-RPC object.
    10441044     *
    1045      * @param object $page The unprepared page data.
     1045     * @param WP_Post $page The unprepared page data.
    10461046     * @return array The prepared page data.
    10471047     */
     
    11231123     * Prepares comment data for return in an XML-RPC object.
    11241124     *
    1125      * @param object $comment The unprepared comment data.
     1125     * @param WP_Comment $comment The unprepared comment data.
    11261126     * @return array The prepared comment data.
    11271127     */
  • trunk/src/wp-includes/ms-blogs.php

    r48320 r49183  
    261261     * @deprecated 4.7.0 Use {@see 'site_details'} instead.
    262262     *
    263      * @param object $details The blog details.
     263     * @param WP_Site $details The blog details.
    264264     */
    265265    $details = apply_filters_deprecated( 'blog_details', array( $details ), '4.7.0', 'site_details' );
  • trunk/src/wp-includes/ms-load.php

    r49038 r49183  
    408408         * @since 3.9.0
    409409         *
    410          * @param object $current_site The network that had been determined.
    411          * @param string $domain       The domain used to search for a site.
    412          * @param string $path         The path used to search for a site.
     410         * @param WP_Network $current_site The network that had been determined.
     411         * @param string     $domain       The domain used to search for a site.
     412         * @param string     $path         The path used to search for a site.
    413413         */
    414414        do_action( 'ms_site_not_found', $current_site, $domain, $path );
  • trunk/src/wp-includes/post-formats.php

    r48197 r49183  
    187187 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    188188 *
    189  * @param string $link
    190  * @param object $term
    191  * @param string $taxonomy
     189 * @param string  $link
     190 * @param WP_Term $term
     191 * @param string  $taxonomy
    192192 * @return string
    193193 */
  • trunk/src/wp-includes/user.php

    r49153 r49183  
    763763 * @param bool $all     Whether to retrieve all sites, or only sites that are not
    764764 *                      marked as deleted, archived, or spam.
    765  * @return array A list of the user's sites. An empty array if the user doesn't exist
    766  *               or belongs to no sites.
     765 * @return object[] A list of the user's sites. An empty array if the user doesn't exist
     766 *                  or belongs to no sites.
    767767 */
    768768function get_blogs_of_user( $user_id, $all = false ) {
     
    784784     * @since 4.6.0
    785785     *
    786      * @param null|array $sites   An array of site objects of which the user is a member.
    787      * @param int        $user_id User ID.
    788      * @param bool       $all     Whether the returned array should contain all sites, including
    789      *                            those marked 'deleted', 'archived', or 'spam'. Default false.
     786     * @param null|object[] $sites   An array of site objects of which the user is a member.
     787     * @param int           $user_id User ID.
     788     * @param bool          $all     Whether the returned array should contain all sites, including
     789     *                               those marked 'deleted', 'archived', or 'spam'. Default false.
    790790     */
    791791    $sites = apply_filters( 'pre_get_blogs_of_user', null, $user_id, $all );
     
    876876     * @since MU (3.0.0)
    877877     *
    878      * @param array $sites   An array of site objects belonging to the user.
    879      * @param int   $user_id User ID.
    880      * @param bool  $all     Whether the returned sites array should contain all sites, including
    881      *                       those marked 'deleted', 'archived', or 'spam'. Default false.
     878     * @param object[] $sites   An array of site objects belonging to the user.
     879     * @param int      $user_id User ID.
     880     * @param bool     $all     Whether the returned sites array should contain all sites, including
     881     *                          those marked 'deleted', 'archived', or 'spam'. Default false.
    882882     */
    883883    return apply_filters( 'get_blogs_of_user', $sites, $user_id, $all );
Note: See TracChangeset for help on using the changeset viewer.