WordPress.org

Make WordPress Core

Changeset 49197


Ignore:
Timestamp:
10/18/2020 08:52:01 PM (11 months ago)
Author:
johnbillion
Message:

Docs: Further corrections and promotions for docblocks relating to object types.

See #50768

Location:
trunk/src
Files:
10 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-walker-category-checklist.php

    r48880 r49197  
    6363     * @since 2.5.1
    6464     *
    65      * @param string $output   Used to append additional content (passed by reference).
    66      * @param object $category The current term object.
    67      * @param int    $depth    Depth of the term in reference to parents. Default 0.
    68      * @param array  $args     An array of arguments. @see wp_terms_checklist()
    69      * @param int    $id       ID of the current term.
     65     * @param string  $output   Used to append additional content (passed by reference).
     66     * @param WP_Term $category The current term object.
     67     * @param int     $depth    Depth of the term in reference to parents. Default 0.
     68     * @param array   $args     An array of arguments. @see wp_terms_checklist()
     69     * @param int     $id       ID of the current term.
    7070     */
    7171    public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
     
    122122     * @since 2.5.1
    123123     *
    124      * @param string $output   Used to append additional content (passed by reference).
    125      * @param object $category The current term object.
    126      * @param int    $depth    Depth of the term in reference to parents. Default 0.
    127      * @param array  $args     An array of arguments. @see wp_terms_checklist()
     124     * @param string  $output   Used to append additional content (passed by reference).
     125     * @param WP_Term $category The current term object.
     126     * @param int     $depth    Depth of the term in reference to parents. Default 0.
     127     * @param array   $args     An array of arguments. @see wp_terms_checklist()
    128128     */
    129129    public function end_el( &$output, $category, $depth = 0, $args = array() ) {
  • trunk/src/wp-admin/includes/class-wp-application-passwords-list-table.php

    r49109 r49197  
    164164     * @since 5.6.0
    165165     *
    166      * @param object $item The current item.
     166     * @param array $item The current item.
    167167     */
    168168    public function single_row( $item ) {
  • trunk/src/wp-admin/includes/class-wp-list-table.php

    r49193 r49197  
    13731373     * @since 3.1.0
    13741374     *
    1375      * @param object $item The current item
     1375     * @param object|array $item The current item
    13761376     */
    13771377    public function single_row( $item ) {
     
    13821382
    13831383    /**
    1384      * @param object $item
     1384     * @param object|array $item
    13851385     * @param string $column_name
    13861386     */
     
    13881388
    13891389    /**
    1390      * @param object $item
     1390     * @param object|array $item
    13911391     */
    13921392    protected function column_cb( $item ) {}
     
    13971397     * @since 3.1.0
    13981398     *
    1399      * @param object $item The current item.
     1399     * @param object|array $item The current item.
    14001400     */
    14011401    protected function single_row_columns( $item ) {
     
    14491449     * @since 4.3.0
    14501450     *
    1451      * @param object $item        The item being acted upon.
    1452      * @param string $column_name Current column name.
    1453      * @param string $primary     Primary column name.
     1451     * @param object|array $item        The item being acted upon.
     1452     * @param string       $column_name Current column name.
     1453     * @param string       $primary     Primary column name.
    14541454     * @return string The row actions HTML, or an empty string
    14551455     *                if the current column is not the primary column.
  • trunk/src/wp-admin/includes/class-wp-ms-sites-list-table.php

    r49108 r49197  
    665665     * @since 4.3.0
    666666     *
    667      * @param object $blog        Site being acted upon.
     667     * @param array $blog        Site being acted upon.
    668668     * @param string $column_name Current column name.
    669669     * @param string $primary     Primary column name.
  • trunk/src/wp-admin/includes/deprecated.php

    r48520 r49197  
    10861086 *
    10871087 * @param int $id
    1088  * @return object
     1088 * @return WP_Post
    10891089 */
    10901090function get_post_to_edit( $id ) {
  • trunk/src/wp-admin/includes/user.php

    r49118 r49197  
    490490 * @since 2.8.0
    491491 *
    492  * @param int    $user_ID
    493  * @param object $old_data
     492 * @param int     $user_ID
     493 * @param WP_User $old_data
    494494 */
    495495function default_password_nag_edit_user( $user_ID, $old_data ) {
  • trunk/src/wp-includes/deprecated.php

    r49188 r49197  
    13041304 * @link https://developer.wordpress.org/reference/functions/get_all_category_ids/
    13051305 *
    1306  * @return object List of all of the category IDs.
     1306 * @return int[] List of all of the category IDs.
    13071307 */
    13081308function get_all_category_ids() {
  • trunk/src/wp-includes/ms-load.php

    r49183 r49197  
    518518 * @deprecated 3.9.0 Use get_current_site() instead.
    519519 *
    520  * @param object $current_site
    521  * @return object
     520 * @param WP_Network $current_site
     521 * @return WP_Network
    522522 */
    523523function get_current_site_name( $current_site ) {
     
    536536 * @deprecated 3.9.0
    537537 *
    538  * @global object $current_site
    539  *
    540  * @return object
     538 * @global WP_Network $current_site
     539 *
     540 * @return WP_Network
    541541 */
    542542function wpmu_current_site() {
  • trunk/src/wp-includes/query.php

    r49095 r49197  
    3838 * @global WP_Query $wp_query WordPress Query object.
    3939 *
    40  * @return object Queried object.
     40 * @return WP_Term|WP_Post_Type|WP_Post|WP_User|null The queried object.
    4141 */
    4242function get_queried_object() {
     
    997997 * @global WP_Query $wp_query WordPress Query object.
    998998 *
    999  * @return object
     999 * @return null
    10001000 */
    10011001function the_comment() {
  • trunk/src/wp-includes/user.php

    r49183 r49197  
    15271527 * @since 3.0.0
    15281528 *
    1529  * @param WP_User $user User object to be cached
     1529 * @param object|WP_User $user User object or database row to be cached
    15301530 * @return bool|null Returns false on failure.
    15311531 */
Note: See TracChangeset for help on using the changeset viewer.