WordPress.org

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/general-template.php

    r48110 r48197  
    12031203 * @global WP_Locale $wp_locale WordPress date and time locale object.
    12041204 *
    1205  * @param string $sep         Optional, default is '»'. How to separate the various items
    1206  *                            within the page title.
    1207  * @param bool   $display     Optional, default is true. Whether to display or retrieve title.
     1205 * @param string $sep         Optional. How to separate the various items within the page title.
     1206 *                            Default '»'.
     1207 * @param bool   $display     Optional. Whether to display or retrieve title. Default true.
    12081208 * @param string $seplocation Optional. Location of the separator ('left' or 'right').
    12091209 * @return string|null String on retrieve, null when displaying.
     
    13491349 *
    13501350 * @param string $prefix  Optional. What to display before the title.
    1351  * @param bool   $display Optional, default is true. Whether to display or retrieve title.
     1351 * @param bool   $display Optional. Whether to display or retrieve title. Default true.
    13521352 * @return string|void Title when retrieving.
    13531353 */
     
    13841384 *
    13851385 * @param string $prefix  Optional. What to display before the title.
    1386  * @param bool   $display Optional, default is true. Whether to display or retrieve title.
     1386 * @param bool   $display Optional. Whether to display or retrieve title. Default true.
    13871387 * @return string|void Title when retrieving, null when displaying or failure.
    13881388 */
     
    14261426 *
    14271427 * @param string $prefix  Optional. What to display before the title.
    1428  * @param bool   $display Optional, default is true. Whether to display or retrieve title.
     1428 * @param bool   $display Optional. Whether to display or retrieve title. Default true.
    14291429 * @return string|void Title when retrieving.
    14301430 */
     
    14431443 *
    14441444 * @param string $prefix  Optional. What to display before the title.
    1445  * @param bool   $display Optional, default is true. Whether to display or retrieve title.
     1445 * @param bool   $display Optional. Whether to display or retrieve title. Default true.
    14461446 * @return string|void Title when retrieving.
    14471447 */
     
    14601460 *
    14611461 * @param string $prefix  Optional. What to display before the title.
    1462  * @param bool   $display Optional, default is true. Whether to display or retrieve title.
     1462 * @param bool   $display Optional. Whether to display or retrieve title. Default true.
    14631463 * @return string|void Title when retrieving.
    14641464 */
     
    15251525 *
    15261526 * @param string $prefix  Optional. What to display before the title.
    1527  * @param bool   $display Optional, default is true. Whether to display or retrieve title.
     1527 * @param bool   $display Optional. Whether to display or retrieve title. Default true.
    15281528 * @return string|void Title when retrieving.
    15291529 */
     
    17531753 * @param string $url      URL to archive.
    17541754 * @param string $text     Archive text description.
    1755  * @param string $format   Optional, default is 'html'. Can be 'link', 'option', 'html', or custom.
     1755 * @param string $format   Optional. Can be 'link', 'option', 'html', or custom. Default 'html'.
    17561756 * @param string $before   Optional. Content to prepend to the description. Default empty.
    17571757 * @param string $after    Optional. Content to append to the description. Default empty.
     
    20812081 * @global array     $posts
    20822082 *
    2083  * @param bool $initial Optional, default is true. Use initial calendar names.
    2084  * @param bool $echo    Optional, default is true. Set to false for return.
     2083 * @param bool $initial Optional. Whether to use initial calendar names. Default true.
     2084 * @param bool $display Optional. Whether to display or return the calendar. Default true.
    20852085 * @return void|string Void if `$echo` argument is true, calendar HTML if `$echo` is false.
    20862086 */
     
    23752375 * @param string $before Optional. Output before the date.
    23762376 * @param string $after  Optional. Output after the date.
    2377  * @param bool   $echo   Optional, default is display. Whether to echo the date or return it.
     2377 * @param bool   $echo   Optional. Whether to echo the date or return it. Default true.
    23782378 * @return string|void String if retrieving.
    23792379 */
     
    24542454 * @param string $before Optional. Output before the date.
    24552455 * @param string $after  Optional. Output after the date.
    2456  * @param bool   $echo   Optional, default is display. Whether to echo the date or return it.
     2456 * @param bool   $echo   Optional. Whether to echo the date or return it. Default true.
    24572457 * @return string|void String if retrieving.
    24582458 */
Note: See TracChangeset for help on using the changeset viewer.