WordPress.org

Make WordPress Core


Ignore:
Timestamp:
01/11/2020 06:30:58 PM (13 months ago)
Author:
SergeyBiryukov
Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/link-template.php

    r46823 r47060  
    468468 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    469469 *
    470  * @param int|bool $year False for current year or year for permalink.
     470 * @param int|false $year Integer of year. False for current year.
    471471 * @return string The permalink for the specified year archive.
    472472 */
     
    502502 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    503503 *
    504  * @param bool|int $year  False for current year. Integer of year.
    505  * @param bool|int $month False for current month. Integer of month.
     504 * @param int|false $year  Integer of year. False for current year.
     505 * @param int|false $month Integer of month. False for current month.
    506506 * @return string The permalink for the specified month and year archive.
    507507 */
     
    542542 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
    543543 *
    544  * @param bool|int $year  False for current year. Integer of year.
    545  * @param bool|int $month False for current month. Integer of month.
    546  * @param bool|int $day   False for current day. Integer of day.
     544 * @param int|false $year  Integer of year. False for current year.
     545 * @param int|false $month Integer of month. False for current month.
     546 * @param int|false $day   Integer of day. False for current day.
    547547 * @return string The permalink for the specified day, month, and year archive.
    548548 */
     
    29692969 *
    29702970 * @param string|array $args Optional args. See paginate_links(). Default empty array.
    2971  * @return string|array|void Markup for comment page links or array of comment page links.
     2971 * @return void|string|array Void if 'echo' argument is true and 'type' is not an array,
     2972 *                           or if the query is not for an existing single post of any post type.
     2973 *                           Otherwise, markup for comment page links or array of comment page links,
     2974 *                           depending on 'type' argument.
    29722975 */
    29732976function paginate_comments_links( $args = array() ) {
     
    40124015 *                                  plus a "found_avatar" guess. Pass as a reference. Default null.
    40134016 * }
    4014  * @return false|string The URL of the avatar we found, or false if we couldn't find an avatar.
     4017 * @return string|false The URL of the avatar on success, false on failure.
    40154018 */
    40164019function get_avatar_url( $id_or_email, $args = null ) {
Note: See TracChangeset for help on using the changeset viewer.