Make WordPress Core


Ignore:
Timestamp:
06/28/2020 11:47:45 AM (19 months ago)
Author:
SergeyBiryukov
Message:

Docs: Improve documentation for optional parameters per the documentation standards.

See #49572.

File:
1 edited

Legend:

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

    r48114 r48197  
    239239 *
    240240 * @param string $more_link_text Optional. Content for when there is more text.
    241  * @param bool   $strip_teaser   Optional. Strip teaser content before the more text. Default is false.
     241 * @param bool   $strip_teaser   Optional. Strip teaser content before the more text. Default false.
    242242 */
    243243function the_content( $more_link_text = null, $strip_teaser = false ) {
     
    270270 *
    271271 * @param string             $more_link_text Optional. Content for when there is more text.
    272  * @param bool               $strip_teaser   Optional. Strip teaser content before the more text. Default is false.
    273  * @param WP_Post|object|int $post           Optional. WP_Post instance or Post ID/object. Default is null.
     272 * @param bool               $strip_teaser   Optional. Strip teaser content before the more text. Default false.
     273 * @param WP_Post|object|int $post           Optional. WP_Post instance or Post ID/object. Default null.
    274274 * @return string
    275275 */
     
    15671567 *
    15681568 * @param int|WP_Post $id Optional. Post ID or post object.
    1569  * @param bool        $fullsize     Optional, default is false. Whether to use full size.
     1569 * @param bool        $fullsize     Optional. Whether to use full size. Default false.
    15701570 * @param bool        $deprecated   Deprecated. Not used.
    1571  * @param bool        $permalink    Optional, default is false. Whether to include permalink.
     1571 * @param bool        $permalink    Optional. Whether to include permalink. Default false.
    15721572 */
    15731573function the_attachment_link( $id = 0, $fullsize = false, $deprecated = false, $permalink = false ) {
     
    15931593 *                                of width and height values in pixels (in that order).
    15941594 *                                Default 'thumbnail'.
    1595  * @param bool         $permalink Optional, Whether to add permalink to image. Default false.
     1595 * @param bool         $permalink Optional. Whether to add permalink to image. Default false.
    15961596 * @param bool         $icon      Optional. Whether the attachment is an icon. Default false.
    15971597 * @param string|false $text      Optional. Link text to use. Activated by passing a string, false otherwise.
     
    18051805 *
    18061806 * @param int|object $revision Revision ID or revision object.
    1807  * @param bool       $link     Optional, default is true. Link to revisions's page?
     1807 * @param bool       $link     Optional. Whether to link to revision's page. Default true.
    18081808 * @return string|false i18n formatted datetimestamp or localized 'Current Revision'.
    18091809 */
     
    18461846 *
    18471847 * @param int|object $revision Revision ID or revision object.
    1848  * @param bool       $link     Optional, default is true. Link to revisions's page?
     1848 * @param bool       $link     Optional. Whether to link to revision's page. Default true.
    18491849 * @return string|false gravatar, user, i18n formatted datetimestamp or localized 'Current Revision'.
    18501850 */
Note: See TracChangeset for help on using the changeset viewer.