Make WordPress Core


Ignore:
Timestamp:
07/20/2022 08:35:17 PM (2 years ago)
Author:
audrasjb
Message:

Docs: Use third-person singular verbs for function descriptions in general-template.php, as per docblocks standards.

See #55646.

File:
1 edited

Legend:

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

    r53715 r53740  
    88
    99/**
    10  * Load header template.
     10 * Loads header template.
    1111 *
    1212 * Includes the header template for a theme or if a name is specified then a
     
    5252
    5353/**
    54  * Load footer template.
     54 * Loads footer template.
    5555 *
    5656 * Includes the footer template for a theme or if a name is specified then a
     
    9696
    9797/**
    98  * Load sidebar template.
     98 * Loads sidebar template.
    9999 *
    100100 * Includes the sidebar template for a theme or if a name is specified then a
     
    208208
    209209/**
    210  * Display search form.
     210 * Displays search form.
    211211 *
    212212 * Will first attempt to locate the searchform.php file in either the child or
     
    363363
    364364/**
    365  * Display the Log In/Out link.
     365 * Displays the Log In/Out link.
    366366 *
    367367 * Displays a link, which allows users to navigate to the Log In page to log in
     
    630630
    631631/**
    632  * Returns the URL that allows the user to retrieve the lost password
     632 * Returns the URL that allows the user to retrieve the lost password.
    633633 *
    634634 * @since 2.8.0
     
    667667
    668668/**
    669  * Display the Registration or Admin link.
     669 * Displays the Registration or Admin link.
    670670 *
    671671 * Display a link which allows the user to navigate to the registration page if
     
    992992
    993993/**
    994  * Whether the site has a Site Icon.
     994 * Determines whether the site has a Site Icon.
    995995 *
    996996 * @since 4.3.0
     
    12941294
    12951295/**
    1296  * Display or retrieve page title for all areas of blog.
     1296 * Displays or retrieves page title for all areas of blog.
    12971297 *
    12981298 * By default, the page title will display the separator before the page title,
     
    14481448
    14491449/**
    1450  * Display or retrieve page title for post.
     1450 * Displays or retrieves page title for post.
    14511451 *
    14521452 * This is optimized for single.php template file for displaying the post title.
     
    14871487
    14881488/**
    1489  * Display or retrieve title for a post type archive.
     1489 * Displays or retrieves title for a post type archive.
    14901490 *
    14911491 * This is optimized for archive.php and archive-{$post_type}.php template files
     
    15281528
    15291529/**
    1530  * Display or retrieve page title for category archive.
     1530 * Displays or retrieves page title for category archive.
    15311531 *
    15321532 * Useful for category template files for displaying the category page title.
     
    15451545
    15461546/**
    1547  * Display or retrieve page title for tag post archive.
     1547 * Displays or retrieves page title for tag post archive.
    15481548 *
    15491549 * Useful for tag template files for displaying the tag page title. The prefix
     
    15621562
    15631563/**
    1564  * Display or retrieve page title for taxonomy term archive.
     1564 * Displays or retrieves page title for taxonomy term archive.
    15651565 *
    15661566 * Useful for taxonomy term template files for displaying the taxonomy term page title.
     
    16241624
    16251625/**
    1626  * Display or retrieve page title for post archive based on date.
     1626 * Displays or retrieves page title for post archive based on date.
    16271627 *
    16281628 * Useful for when the template only needs to display the month and year,
     
    16671667
    16681668/**
    1669  * Display the archive title based on the queried object.
     1669 * Displays the archive title based on the queried object.
    16701670 *
    16711671 * @since 4.1.0
     
    16851685
    16861686/**
    1687  * Retrieve the archive title based on the queried object.
     1687 * Retrieves the archive title based on the queried object.
    16881688 *
    16891689 * @since 4.1.0
     
    17831783
    17841784/**
    1785  * Display category, tag, term, or author description.
     1785 * Displays category, tag, term, or author description.
    17861786 *
    17871787 * @since 4.1.0
     
    18641864
    18651865/**
    1866  * Retrieve archive link content based on predefined or custom code.
     1866 * Retrieves archive link content based on predefined or custom code.
    18671867 *
    18681868 * The format can be one of four styles. The 'link' for head element, 'option'
     
    19331933
    19341934/**
    1935  * Display archive links based on type and format.
     1935 * Displays archive links based on type and format.
    19361936 *
    19371937 * @since 1.2.0
     
    21932193
    21942194/**
    2195  * Get number of days since the start of the week.
     2195 * Gets number of days since the start of the week.
    21962196 *
    21972197 * @since 1.5.0
     
    22062206
    22072207/**
    2208  * Display calendar with days that have posts as links.
     2208 * Displays calendar with days that have posts as links.
    22092209 *
    22102210 * The calendar is cached, which will be retrieved, if it exists. If there are
     
    24472447
    24482448/**
    2449  * Purge the cached results of get_calendar.
     2449 * Purges the cached results of get_calendar.
    24502450 *
    24512451 * @see get_calendar()
     
    24572457
    24582458/**
    2459  * Display all of the allowed tags in HTML format with attributes.
     2459 * Displays all of the allowed tags in HTML format with attributes.
    24602460 *
    24612461 * This is useful for displaying in the comment area, which elements and
     
    24962496
    24972497/**
    2498  * Display or Retrieve the date the current post was written (once per date)
     2498 * Displays or retrieves the date the current post was written (once per date)
    24992499 *
    25002500 * Will only output the date if the current post's date is different from the
     
    25482548
    25492549/**
    2550  * Retrieve the date on which the post was written.
     2550 * Retrieves the date on which the post was written.
    25512551 *
    25522552 * Unlike the_date() this function will always return the date.
     
    25832583
    25842584/**
    2585  * Display the date on which the post was last modified.
     2585 * Displays the date on which the post was last modified.
    25862586 *
    25872587 * @since 2.1.0
     
    26172617
    26182618/**
    2619  * Retrieve the date on which the post was last modified.
     2619 * Retrieves the date on which the post was last modified.
    26202620 *
    26212621 * @since 2.1.0
     
    26522652
    26532653/**
    2654  * Display the time at which the post was written.
     2654 * Displays the time at which the post was written.
    26552655 *
    26562656 * @since 0.71
     
    26742674
    26752675/**
    2676  * Retrieve the time at which the post was written.
     2676 * Retrieves the time at which the post was written.
    26772677 *
    26782678 * @since 1.5.0
     
    27102710
    27112711/**
    2712  * Retrieve the time at which the post was written.
     2712 * Retrieves the time at which the post was written.
    27132713 *
    27142714 * @since 2.0.0
     
    27672767
    27682768/**
    2769  * Retrieve post published or modified time as a `DateTimeImmutable` object instance.
     2769 * Retrieves post published or modified time as a `DateTimeImmutable` object instance.
    27702770 *
    27712771 * The object will be set to the timezone from WordPress settings.
     
    28162816
    28172817/**
    2818  * Retrieve post published or modified time as a Unix timestamp.
     2818 * Retrieves post published or modified time as a Unix timestamp.
    28192819 *
    28202820 * Note that this function returns a true Unix timestamp, not summed with timezone offset
     
    28392839
    28402840/**
    2841  * Display the time at which the post was last modified.
     2841 * Displays the time at which the post was last modified.
    28422842 *
    28432843 * @since 2.0.0
     
    28612861
    28622862/**
    2863  * Retrieve the time at which the post was last modified.
     2863 * Retrieves the time at which the post was last modified.
    28642864 *
    28652865 * @since 2.0.0
     
    28992899
    29002900/**
    2901  * Retrieve the time at which the post was last modified.
     2901 * Retrieves the time at which the post was last modified.
    29022902 *
    29032903 * @since 2.0.0
     
    29562956
    29572957/**
    2958  * Display the weekday on which the post was written.
     2958 * Displays the weekday on which the post was written.
    29592959 *
    29602960 * @since 0.71
     
    29842984
    29852985/**
    2986  * Display the weekday on which the post was written.
     2986 * Displays the weekday on which the post was written.
    29872987 *
    29882988 * Will only output the weekday if the current post's weekday is different from
     
    30293029
    30303030/**
    3031  * Fire the wp_head action.
     3031 * Fires the wp_head action.
    30323032 *
    30333033 * See {@see 'wp_head'}.
     
    30453045
    30463046/**
    3047  * Fire the wp_footer action.
     3047 * Fires the wp_footer action.
    30483048 *
    30493049 * See {@see 'wp_footer'}.
     
    30613061
    30623062/**
    3063  * Fire the wp_body_open action.
     3063 * Fires the wp_body_open action.
    30643064 *
    30653065 * See {@see 'wp_body_open'}.
     
    30773077
    30783078/**
    3079  * Display the links to the general feeds.
     3079 * Displays the links to the general feeds.
    30803080 *
    30813081 * @since 2.8.0
     
    31233123
    31243124/**
    3125  * Display the links to the extra feeds such as category feeds.
     3125 * Displays the links to the extra feeds such as category feeds.
    31263126 *
    31273127 * @since 2.8.0
     
    32133213
    32143214/**
    3215  * Display the link to the Really Simple Discovery service endpoint.
     3215 * Displays the link to the Really Simple Discovery service endpoint.
    32163216 *
    32173217 * @link http://archipelago.phrasewise.com/rsd
     
    32233223
    32243224/**
    3225  * Display the link to the Windows Live Writer manifest file.
     3225 * Displays the link to the Windows Live Writer manifest file.
    32263226 *
    32273227 * @link https://msdn.microsoft.com/en-us/library/bb463265.aspx
     
    32513251
    32523252/**
    3253  * Display site icon meta tags.
     3253 * Displays site icon meta tags.
    32543254 *
    32553255 * @since 4.3.0
     
    34603460
    34613461/**
    3462  * Whether the user can access the visual editor.
     3462 * Determines whether the user can access the visual editor.
    34633463 *
    34643464 * Checks if the user can access the visual editor and that it's supported by the user's browser.
     
    35043504
    35053505/**
    3506  * Find out which editor should be displayed by default.
     3506 * Finds out which editor should be displayed by default.
    35073507 *
    35083508 * Works out which of the two editors to display as the current editor for a
     
    35763576
    35773577/**
    3578  * Enqueue assets needed by the code editor for the given settings.
     3578 * Enqueues assets needed by the code editor for the given settings.
    35793579 *
    35803580 * @since 4.9.0
     
    36693669
    36703670/**
    3671  * Generate and return code editor settings.
     3671 * Generates and returns code editor settings.
    36723672 *
    36733673 * @since 5.0.0
     
    46884688
    46894689/**
    4690  * Display the generator XML or Comment for RSS, ATOM, etc.
     4690 * Displays the generator XML or Comment for RSS, ATOM, etc.
    46914691 *
    46924692 * Returns the correct generator type for the requested output format. Allows
     
    49094909
    49104910/**
    4911  * Default settings for heartbeat
    4912  *
    4913  * Outputs the nonce used in the heartbeat XHR
     4911 * Default settings for heartbeat.
     4912 *
     4913 * Outputs the nonce used in the heartbeat XHR.
    49144914 *
    49154915 * @since 3.6.0
Note: See TracChangeset for help on using the changeset viewer.