sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.

Browse Source 
See #30469.


git-svn-id: https://develop.svn.wordpress.org/trunk@30616 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-11-28 11:56:20 +00:00
parent 426d221772
commit 8c059c65a4
1 changed files with 20 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
src/wp-includes/link-template.php
View File

@ -2190,11 +2190,11 @@ function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) {
* @since 4.1.0 * @since 4.1.0
* *
* @param array $args { * @param array $args {
* Optional. Default post navigation arguments. * 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 $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 $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'. * @type string $screen_reader_text Screen reader text for nav element. Default 'Post navigation'.
* } * }
* @return string Markup for post links. * @return string Markup for post links.
*/ */
@ -2222,7 +2222,8 @@ function get_the_post_navigation( $args = array() ) {
* *
* @since 4.1.0 * @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() ) { function the_post_navigation( $args = array() ) {
echo get_the_post_navigation( $args ); echo get_the_post_navigation( $args );
@ -2236,11 +2237,14 @@ function the_post_navigation( $args = array() ) {
* @global WP_Query $wp_query WordPress Query object. * @global WP_Query $wp_query WordPress Query object.
* *
* @param array $args { * @param array $args {
* Optional. Default paging navigation arguments. * 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 $prev_text Anchor text to display in the previous posts link.
* @type string $next_text Anchor text to display in the next posts link. Default: `Newer posts`. * Default 'Older posts'.
* @type string $screen_reader_text Screen reader text for nav element. Default: 'Posts navigation'. * @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. * @return string Markup for paging links.
*/ */
@ -2277,7 +2281,8 @@ function get_the_posts_navigation( $args = array() ) {
* *
* @since 4.1.0 * @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() ) { function the_posts_navigation( $args = array() ) {
echo get_the_posts_navigation( $args ); echo get_the_posts_navigation( $args );
@ -2290,9 +2295,10 @@ function the_posts_navigation( $args = array() ) {
* @since 4.1.0 * @since 4.1.0
* *
* @param array $args { * @param array $args {
* Optional. Default pagination arguments. {@see paginate_links()} * Optional. Default pagination arguments, {@see paginate_links()}.
* *
* @type string $screen_reader_text Screen reader text for navigation element. Default: 'Posts navigation'. * @type string $screen_reader_text Screen reader text for navigation element.
* Default 'Posts navigation'.
* } * }
* @return string Markup for pagination links. * @return string Markup for pagination links.
*/ */
@ -2327,7 +2333,8 @@ function get_the_pagination( $args = array() ) {
* *
* @since 4.1.0 * @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() ) { function the_pagination( $args = array() ) {
echo get_the_pagination( $args ); echo get_the_pagination( $args );