WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects 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. 

See #30469.

Built from https://develop.svn.wordpress.org/trunk@30616


git-svn-id: http://core.svn.wordpress.org/trunk@30606 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-28 11:57:24 +00:00
parent a4be4f520f
commit 494a15e1cd
2 changed files with 21 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -2190,11 +2190,11 @@ function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) {
* @since 4.1.0
*
* @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 $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 $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.
*/
@ -2222,7 +2222,8 @@ function get_the_post_navigation( $args = array() ) {
*
* @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() ) {
echo get_the_post_navigation( $args );
@ -2236,11 +2237,14 @@ function the_post_navigation( $args = array() ) {
* @global WP_Query $wp_query WordPress Query object.
*
* @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 $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'.
* @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.
*/
@ -2277,7 +2281,8 @@ function get_the_posts_navigation( $args = array() ) {
*
* @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() ) {
echo get_the_posts_navigation( $args );
@ -2290,9 +2295,10 @@ function the_posts_navigation( $args = array() ) {
* @since 4.1.0
*
* @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.
*/
@ -2327,7 +2333,8 @@ function get_the_pagination( $args = array() ) {
*
* @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() ) {
echo get_the_pagination( $args );

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.1-beta2-30615';
$wp_version = '4.1-beta2-30616';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.