Changeset 30616

Timestamp:

11/28/2014 11:56:20 AM (11 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:

• trunk/src/wp-includes/link-template.php (modified) (6 diffs)

trunk/src/wp-includes/link-template.php

@@ -2191 +2191 @@
  *
  * @param array $args {
- *     Optional. Default post navigation arguments.
- *
- *     @type string $prev_text          Anchor text to display in the previous post link. Default: `%title`.
- *     @type string $next_text          Anchor text to display in the next post link. Default: `%title`.
- *     @type string $screen_reader_text Screen reader text for nav element. Default: 'Post navigation'.
+ *     Optional. Default post navigation arguments. Default empty array.
+ *
+ *     @type string $prev_text          Anchor text to display in the previous post link. Default `%title`.
+ *     @type string $next_text          Anchor text to display in the next post link. Default `%title`.
+ *     @type string $screen_reader_text Screen reader text for nav element. Default 'Post navigation'.
  * }
  * @return string Markup for post links.
@@ -2223 +2223 @@
  * @since 4.1.0
  *
- * @param array $args See {@see get_the_post_navigation()} for available arguments.
+ * @param array $args Optional. See {@see get_the_post_navigation()} for available
+ *                    arguments. Default empty array.
  */
 function the_post_navigation( $args = array() ) {
@@ -2237 +2238 @@
  *
  * @param array $args {
- *     Optional. Default paging navigation arguments.
- *
- *     @type string $prev_text          Anchor text to display in the previous posts link. Default: `Older posts`.
- *     @type string $next_text          Anchor text to display in the next posts link. Default: `Newer posts`.
- *     @type string $screen_reader_text Screen reader text for nav element. Default: 'Posts navigation'.
+ *     Optional. Default paging navigation arguments. Default empty array.
+ *
+ *     @type string $prev_text          Anchor text to display in the previous posts link.
+ *                                      Default 'Older posts'.
+ *     @type string $next_text          Anchor text to display in the next posts link.
+ *                                      Default 'Newer posts'.
+ *     @type string $screen_reader_text Screen reader text for nav element.
+ *                                      Default 'Posts navigation'.
  * }
  * @return string Markup for paging links.
@@ -2278 +2282 @@
  * @since 4.1.0
  *
- * @param array $args See {@see get_the_posts_navigation()} for available arguments.
+ * @param array $args Optional. See {@see get_the_posts_navigation()} for available
+ *                    arguments. Default empty array.
  */
 function the_posts_navigation( $args = array() ) {
@@ -2291 +2296 @@
  *
  * @param array $args {
- *     Optional. Default pagination arguments. {@see paginate_links()}
- *
- *     @type string $screen_reader_text Screen reader text for navigation element. Default: 'Posts navigation'.
+ *     Optional. Default pagination arguments, {@see paginate_links()}.
+ *
+ *     @type string $screen_reader_text Screen reader text for navigation element.
+ *                                      Default 'Posts navigation'.
  * }
  * @return string Markup for pagination links.
@@ -2328 +2334 @@
  * @since 4.1.0
  *
- * @param array $args See {@see get_the_pagination()} for available arguments.
+ * @param array $args Optional. See {@see get_the_pagination()} for available arguments.
+ *                    Default empty array.
  */
 function the_pagination( $args = array() ) {