<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[30065] trunk/src/wp-includes/link-template.php: Introduce some new template functions for navigation:</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/30065">30065</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/30065","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-10-28 19:38:41 +0000 (Tue, 28 Oct 2014)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Introduce some new template functions for navigation:
* `get_the_post_navigation()` and `the_post_navigation()` for navigation to the next and previous post.
* `get_the_posts_navigation() and `the_posts_navigation()` for navigation to the next and previous page of posts.
* `get_the_pagination()` and `the_pagination()` for paginated navigation between pages of posts. Uses `paginate_links()`.
This reduces the need for themes to define their own sets of navigation functions.
Fixes <a href="https://core.trac.wordpress.org/ticket/29808">#29808</a>.
Props obenland.
</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeslinktemplatephp">trunk/src/wp-includes/link-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeslinktemplatephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/link-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/link-template.php 2014-10-28 19:35:17 UTC (rev 30064)
+++ trunk/src/wp-includes/link-template.php 2014-10-28 19:38:41 UTC (rev 30065)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2188,6 +2188,200 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Return navigation to next/previous post when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args {
+ * Optional. Default post navigation arguments.
+ *
+ * @type string $prev_text Anchor text to display in the previous post link.
+ * Default: `<span class="meta-nav">←</span> %title`.
+ * @type string $next_text Anchor text to display in the next post link.
+ * Default: `%title <span class="meta-nav">→</span>`.
+ * }
+ * @return string Markup for post links.
+ */
+function get_the_post_navigation( $args = array() ) {
+ $args = wp_parse_args( $args, array(
+ 'prev_text' => _x( '<span class="meta-nav">←</span> %title', 'Previous post link' ),
+ 'next_text' => _x( '%title <span class="meta-nav">→</span>', 'Next post link' ),
+ ) );
+
+ $navigation = '';
+ $previous = get_previous_post_link( '<div class="nav-previous">%link</div>', $args['prev_text'] );
+ $next = get_next_post_link( '<div class="nav-next">%link</div>', $args['next_text'] );
+
+ // Only add markup if there's somewhere to navigate to.
+ if ( $next || $previous ) {
+ $navigation = _navigation_markup( $next . $previous, 'post-navigation', __( 'Post navigation' ) );
+ }
+
+ return $navigation;
+}
+
+/**
+ * Display navigation to next/previous post when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args See {@see get_the_post_navigation()} for available arguments.
+ */
+function the_post_navigation( $args = array() ) {
+ echo get_the_post_navigation( $args );
+}
+
+/**
+ * Return navigation to next/previous set of posts when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @global WP_Query $wp_query WordPress Query object.
+ *
+ * @param array $args {
+ * Optional. Default paging navigation arguments.
+ *
+ * @type string $prev_text Anchor text to display in the previous posts link.
+ * Default: `<span class="meta-nav">←</span> Older posts`.
+ * @type string $next_text Anchor text to display in the next posts link.
+ * Default: `Newer posts <span class="meta-nav">→</span>`.
+ * }
+ * @return string Markup for paging links.
+ */
+function get_the_posts_navigation( $args = array() ) {
+ $navigation = '';
+
+ // Don't print empty markup if there's only one page.
+ if ( $GLOBALS['wp_query']->max_num_pages > 1 ) {
+ $args = wp_parse_args( $args, array(
+ 'prev_text' => __( '<span class="meta-nav">←</span> Older posts' ),
+ 'next_text' => __( 'Newer posts <span class="meta-nav">→</span>' ),
+ ) );
+
+ $next_link = get_next_posts_link( $args['prev_text'] );
+ $prev_link = get_previous_posts_link( $args['next_text'] );
+
+ if ( $next_link ) {
+ $navigation .= '<div class="nav-previous">' . $next_link . '</div>';
+ }
+
+ if ( $prev_link ) {
+ $navigation .= '<div class="nav-next">' . $prev_link . '</div>';
+ }
+
+ $navigation = _navigation_markup( $navigation );
+ }
+
+ return $navigation;
+}
+
+/**
+ * Display navigation to next/previous set of posts when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args See {@see get_the_posts_navigation()} for available arguments.
+ */
+function the_posts_navigation( $args = array() ) {
+ echo get_the_posts_navigation( $args );
+}
+
+/**
+ * Return a paginated navigation to next/previous set of posts,
+ * when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args {
+ * Optional. Default pagination arguments.
+ *
+ * @type string $base URL to be used to create the paginated links.
+ * Example: `http://example.com/all_posts.php%_%`
+ * The `%_%` is required and will be replaced by the contents of the
+ * 'format' argument.
+ * Default: Current page number link with appended `%_%`.
+ * @type string $format Used to replace the page number. Example: `?page=%#%`
+ * The `%#%` is required and will be replaced with the page number.
+ * Default: Current permalink format with appended `%#%`.
+ * @type int $total The total amount of pages. Default: Value of 'max_num_pages' of current query.
+ * @type int $current The current page number. Default: Value of 'paged' query var.
+ * @type bool $prev_next Whether to include previous and next links. Default: true.
+ * @type string $prev_text Anchor text to display in the previous posts link. Default: `← Previous`.
+ * @type string $next_text Anchor text to display in the next posts link. Default: `Next →`.
+ * @type bool $show_all Whether to show all pages.
+ * Default: false, shows short list of the pages near the current page.
+ * @type int $end_size Amount of numbers on either the start and the end list edges. Default: 1.
+ * @type int $mid_size Amount of numbers to either side of current page but not including current page.
+ * Default: 1.
+ * @type array $add_args Query vars to be added to the links. Accepts an associative array of arguments.
+ * Default: Empty array.
+ * @type string $before_page_number Text to prepend to the anchor text. Default: Empty string.
+ * @type string $after_page_number Text to append to the anchor text. Default: Empty string.
+ * }
+ * @return string Markup for pagination links.
+ */
+function get_the_pagination( $args = array() ) {
+ $navigation = '';
+
+ // Don't print empty markup if there's only one page.
+ if ( $GLOBALS['wp_query']->max_num_pages > 1 ) {
+ $args = wp_parse_args( $args, array(
+ 'mid_size' => 1,
+ 'prev_text' => __( '← Previous' ),
+ 'next_text' => __( 'Next →' ),
+ ) );
+ // Make sure we get plain links, so we can work with it.
+ $args['type'] = 'plain';
+
+ // Set up paginated links.
+ $links = paginate_links( $args );
+
+ if ( $links ) {
+ $navigation = _navigation_markup( $links, 'pagination' );
+ }
+ }
+
+ return $navigation;
+}
+
+/**
+ * Display a paginated navigation to next/previous set of posts,
+ * when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args See {@see get_the_pagination()} for available arguments.
+ */
+function the_pagination( $args = array() ) {
+ echo get_the_pagination( $args );
+}
+
+/**
+ * Wraps passed links in navigational markup.
+ *
+ * @since 4.1.0
+ * @access private
+ *
+ * @param string $links Navigational links.
+ * @param string $class Optional. Custom class for nav element. Default: 'paging-navigation'.
+ * @param string $screen_reader_text Optional. Screen reader text for nav element. Default: 'Posts navigation'.
+ * @return string Navigation template tag.
+ */
+function _navigation_markup( $links, $class = 'paging-navigation', $screen_reader_text = '' ) {
+ if ( empty( $screen_reader_text ) ) {
+ $screen_reader_text = __( 'Posts navigation' );
+ }
+
+ $template = '
+ <nav class="navigation %1$s" role="navigation">
+ <h1 class="screen-reader-text">%2$s</h1>
+ <div class="nav-links">%3$s</div>
+ </nav>';
+
+ return sprintf( $template, sanitize_html_class( $class ), esc_html( $screen_reader_text ), $links );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Retrieve comments page number link.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span></span></pre>
</div>
</div>
</body>
</html>