Make WordPress Core


Ignore:
Timestamp:
11/28/2014 11:56:20 AM (10 years ago)
Author:
DrewAPicture
Message:

4.1 Docs Audit: Ensure optional arguments in get_the_post_navigation(), the_post_navigation(), get_the_posts_navigation(), the_posts_navigation(), get_the_pagination(), and the_pagination() are properly documented with defaults.

See #30469.

File:
1 edited

Legend:

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

    r30457 r30616  
    21912191 *
    21922192 * @param array $args {
    2193  *     Optional. Default post navigation arguments.
    2194  *
    2195  *     @type string $prev_text          Anchor text to display in the previous post link. Default: `%title`.
    2196  *     @type string $next_text          Anchor text to display in the next post link. Default: `%title`.
    2197  *     @type string $screen_reader_text Screen reader text for nav element. Default: 'Post navigation'.
     2193 *     Optional. Default post navigation arguments. Default empty array.
     2194 *
     2195 *     @type string $prev_text          Anchor text to display in the previous post link. Default `%title`.
     2196 *     @type string $next_text          Anchor text to display in the next post link. Default `%title`.
     2197 *     @type string $screen_reader_text Screen reader text for nav element. Default 'Post navigation'.
    21982198 * }
    21992199 * @return string Markup for post links.
     
    22232223 * @since 4.1.0
    22242224 *
    2225  * @param array $args See {@see get_the_post_navigation()} for available arguments.
     2225 * @param array $args Optional. See {@see get_the_post_navigation()} for available
     2226 *                    arguments. Default empty array.
    22262227 */
    22272228function the_post_navigation( $args = array() ) {
     
    22372238 *
    22382239 * @param array $args {
    2239  *     Optional. Default paging navigation arguments.
    2240  *
    2241  *     @type string $prev_text          Anchor text to display in the previous posts link. Default: `Older posts`.
    2242  *     @type string $next_text          Anchor text to display in the next posts link. Default: `Newer posts`.
    2243  *     @type string $screen_reader_text Screen reader text for nav element. Default: 'Posts navigation'.
     2240 *     Optional. Default paging navigation arguments. Default empty array.
     2241 *
     2242 *     @type string $prev_text          Anchor text to display in the previous posts link.
     2243 *                                      Default 'Older posts'.
     2244 *     @type string $next_text          Anchor text to display in the next posts link.
     2245 *                                      Default 'Newer posts'.
     2246 *     @type string $screen_reader_text Screen reader text for nav element.
     2247 *                                      Default 'Posts navigation'.
    22442248 * }
    22452249 * @return string Markup for paging links.
     
    22782282 * @since 4.1.0
    22792283 *
    2280  * @param array $args See {@see get_the_posts_navigation()} for available arguments.
     2284 * @param array $args Optional. See {@see get_the_posts_navigation()} for available
     2285 *                    arguments. Default empty array.
    22812286 */
    22822287function the_posts_navigation( $args = array() ) {
     
    22912296 *
    22922297 * @param array $args {
    2293  *     Optional. Default pagination arguments. {@see paginate_links()}
    2294  *
    2295  *     @type string $screen_reader_text Screen reader text for navigation element. Default: 'Posts navigation'.
     2298 *     Optional. Default pagination arguments, {@see paginate_links()}.
     2299 *
     2300 *     @type string $screen_reader_text Screen reader text for navigation element.
     2301 *                                      Default 'Posts navigation'.
    22962302 * }
    22972303 * @return string Markup for pagination links.
     
    23282334 * @since 4.1.0
    23292335 *
    2330  * @param array $args See {@see get_the_pagination()} for available arguments.
     2336 * @param array $args Optional. See {@see get_the_pagination()} for available arguments.
     2337 *                    Default empty array.
    23312338 */
    23322339function the_pagination( $args = array() ) {
Note: See TracChangeset for help on using the changeset viewer.