Make WordPress Core

Ticket #54729: 54729.2.diff

File 54729.2.diff, 6.5 KB (added by azouamauriac, 3 years ago)

in src/wp-includes/post-template.php and src/wp-includes/post-thumbnail-template.php use third person in function docblock

  • src/wp-includes/post-template.php

     
    99 */
    1010
    1111/**
    12  * Display the ID of the current item in the WordPress Loop.
     12 * Displays the ID of the current item in the WordPress Loop.
    1313 *
    1414 * @since 0.71
    1515 */
     
    1818}
    1919
    2020/**
    21  * Retrieve the ID of the current item in the WordPress Loop.
     21 * Retrieves the ID of the current item in the WordPress Loop.
    2222 *
    2323 * @since 2.1.0
    2424 *
     
    3030}
    3131
    3232/**
    33  * Display or retrieve the current post title with optional markup.
     33 * Displays or retrieves the current post title with optional markup.
    3434 *
    3535 * @since 0.71
    3636 *
     
    5656}
    5757
    5858/**
    59  * Sanitize the current title when retrieving or displaying.
     59 * Sanitizes the current title when retrieving or displaying.
    6060 *
    6161 * Works like the_title(), except the parameters can be in a string or
    6262 * an array. See the function for what can be override in the $args parameter.
     
    103103}
    104104
    105105/**
    106  * Retrieve post title.
     106 * Retrieves post title.
    107107 *
    108108 * If the post is protected and the visitor is not an admin, then "Protected"
    109109 * will be displayed before the post title. If the post is private, then
     
    172172}
    173173
    174174/**
    175  * Display the Post Global Unique Identifier (guid).
     175 * Displays the Post Global Unique Identifier (guid).
    176176 *
    177177 * The guid will appear to be a link, but should not be used as a link to the
    178178 * post. The reason you should not use it as a link, is because of moving the
     
    204204}
    205205
    206206/**
    207  * Retrieve the Post Global Unique Identifier (guid).
     207 * Retrieves the Post Global Unique Identifier (guid).
    208208 *
    209209 * The guid will appear to be a link, but should not be used as an link to the
    210210 * post. The reason you should not use it as a link, is because of moving the
     
    233233}
    234234
    235235/**
    236  * Display the post content.
     236 * Displays the post content.
    237237 *
    238238 * @since 0.71
    239239 *
     
    256256}
    257257
    258258/**
    259  * Retrieve the post content.
     259 * Retrieves the post content.
    260260 *
    261261 * @since 0.71
    262262 * @since 5.2.0 Added the `$post` parameter.
     
    376376}
    377377
    378378/**
    379  * Display the post excerpt.
     379 * Displays the post excerpt.
    380380 *
    381381 * @since 0.71
    382382 */
     
    10631063//
    10641064
    10651065/**
    1066  * Retrieve post custom meta data field.
     1066 * Retrieves post custom meta data field.
    10671067 *
    10681068 * @since 1.5.0
    10691069 *
     
    10841084}
    10851085
    10861086/**
    1087  * Display a list of post custom fields.
     1087 * Displays a list of post custom fields.
    10881088 *
    10891089 * @since 1.2.0
    10901090 *
     
    11331133//
    11341134
    11351135/**
    1136  * Retrieve or display a list of pages as a dropdown (select list).
     1136 * Retrieves or displays a list of pages as a dropdown (select list).
    11371137 *
    11381138 * @since 2.1.0
    11391139 * @since 4.2.0 The `$value_field` argument was added.
     
    12241224}
    12251225
    12261226/**
    1227  * Retrieve or display a list of pages (or hierarchical post type items) in list (li) format.
     1227 * Retrieves or displays a list of pages (or hierarchical post type items) in list (li) format.
    12281228 *
    12291229 * @since 1.5.0
    12301230 * @since 4.7.0 Added the `item_spacing` argument.
     
    15131513//
    15141514
    15151515/**
    1516  * Retrieve HTML list content for page list.
     1516 * Retrieves HTML list content for page list.
    15171517 *
    15181518 * @uses Walker_Page to create HTML list content.
    15191519 * @since 2.1.0
     
    15441544}
    15451545
    15461546/**
    1547  * Retrieve HTML dropdown (select) content for page list.
     1547 * Retrieves HTML dropdown (select) content for page list.
    15481548 *
    15491549 * @since 2.1.0
    15501550 * @since 5.3.0 Formalized the existing `...$args` parameter by adding it
     
    15741574//
    15751575
    15761576/**
    1577  * Display an attachment page link using an image or icon.
     1577 * Displays an attachment page link using an image or icon.
    15781578 *
    15791579 * @since 2.0.0
    15801580 *
     
    15961596}
    15971597
    15981598/**
    1599  * Retrieve an attachment page link using an image or icon, if possible.
     1599 * Retrieves an attachment page link using an image or icon, if possible.
    16001600 *
    16011601 * @since 2.5.0
    16021602 * @since 4.4.0 The `$id` parameter can now accept either a post ID or `WP_Post` object.
     
    16581658}
    16591659
    16601660/**
    1661  * Wrap attachment in paragraph tag before content.
     1661 * Wraps attachment in paragraph tag before content.
    16621662 *
    16631663 * @since 2.0.0
    16641664 *
     
    17111711//
    17121712
    17131713/**
    1714  * Retrieve protected post password form content.
     1714 * Retrieves protected post password form content.
    17151715 *
    17161716 * @since 1.0.0
    17171717 *
     
    17871787}
    17881788
    17891789/**
    1790  * Get the specific template filename for a given post.
     1790 * Gets the specific template filename for a given post.
    17911791 *
    17921792 * @since 3.4.0
    17931793 * @since 4.7.0 Now works with any post type, not just pages.
     
    18131813}
    18141814
    18151815/**
    1816  * Retrieve formatted date timestamp of a revision (linked to that revisions's page).
     1816 * Retrieves formatted date timestamp of a revision (linked to that revisions's page).
    18171817 *
    18181818 * @since 2.6.0
    18191819 *
     
    18541854}
    18551855
    18561856/**
    1857  * Retrieve formatted date timestamp of a revision (linked to that revisions's page).
     1857 * Retrieves formatted date timestamp of a revision (linked to that revisions's page).
    18581858 *
    18591859 * @since 3.6.0
    18601860 *
     
    19181918}
    19191919
    19201920/**
    1921  * Display a list of a post's revisions.
     1921 * Displays a list of a post's revisions.
    19221922 *
    19231923 * Can output either a UL with edit links or a TABLE with diff interface, and
    19241924 * restore action links.
  • src/wp-includes/post-thumbnail-template.php

     
    3939}
    4040
    4141/**
    42  * Retrieve post thumbnail ID.
     42 * Retrieves post thumbnail ID.
    4343 *
    4444 * @since 2.9.0
    4545 * @since 4.4.0 `$post` can be a post ID or WP_Post object.
     
    7171}
    7272
    7373/**
    74  * Display the post thumbnail.
     74 * Displays the post thumbnail.
    7575 *
    7676 * When a theme adds 'post-thumbnail' support, a special 'post-thumbnail' image size
    7777 * is registered, which differs from the 'thumbnail' image size managed via the
     
    9393}
    9494
    9595/**
    96  * Update cache for thumbnails in the current loop.
     96 * Updates cache for thumbnails in the current loop.
    9797 *
    9898 * @since 3.2.0
    9999 *
     
    127127}
    128128
    129129/**
    130  * Retrieve the post thumbnail.
     130 * Retrieves the post thumbnail.
    131131 *
    132132 * When a theme adds 'post-thumbnail' support, a special 'post-thumbnail' image size
    133133 * is registered, which differs from the 'thumbnail' image size managed via the
     
    233233}
    234234
    235235/**
    236  * Return the post thumbnail URL.
     236 * Returns the post thumbnail URL.
    237237 *
    238238 * @since 4.4.0
    239239 *
     
    266266}
    267267
    268268/**
    269  * Display the post thumbnail URL.
     269 * Displays the post thumbnail URL.
    270270 *
    271271 * @since 4.4.0
    272272 *