Ticket #29808: 29808.9.diff

src/wp-includes/link-template.php

@@ -2559 +2559 @@
 }
 
 /**
+ * Return navigation to next/previous set of comments when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args {
+ *     Optional. Default comments navigation arguments.
+ *
+ *     @type string $prev_text Anchor text to display in the previous comments link. Default: `Older comments`.
+ *     @type string $next_text Anchor text to display in the next comments link. Default: `Newer comments`.
+ * }
+ * @return string Markup for comments links.
+ */
+function get_the_comments_navigation( $args = array() ) {
+        $navigation = '';
+
+        // Are there comments to navigate through?
+        if ( get_comment_pages_count() > 1 && get_option( 'page_comments' ) ) {
+                $args = wp_parse_args( $args, array(
+                        'prev_text' => __( 'Older comments' ),
+                        'next_text' => __( 'Newer comments' ),
+                ) );
+
+                $prev_link = get_previous_comments_link( $args['prev_text'] );
+                $next_link = get_next_comments_link( $args['next_text'] );
+
+                if ( $prev_link ) {
+                        $navigation .= '<div class="nav-previous">' . $prev_link . '</div>';
+                }
+
+                if ( $next_link ) {
+                        $navigation .= '<div class="nav-next">' . $next_link . '</div>';
+                }
+
+                $navigation = _navigation_markup( $navigation, 'comment-navigation', __( 'Comments navigation' ) );
+        }
+
+        return $navigation;
+}
+
+/**
+ * Display navigation to next/previous set of comments when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args See {@see get_the_comments_navigation()} for available arguments.
+ */
+function the_comments_navigation( $args = array() ) {
+        echo get_the_comments_navigation( $args );
+}
+
+/**
+ * Return a paginated navigation to next/previous set of comments,
+ * 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: `&laquo; Previous`.
+ *     @type string $next_text          Anchor text to display in the next posts link. Default: `Next &raquo;`.
+ *     @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: 2.
+ *     @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_comments_pagination( $args = array() ) {
+        $navigation   = '';
+        $args['echo'] = false;
+
+        $links = paginate_comments_links( $args );
+
+        if ( $links ) {
+                $navigation = _navigation_markup( $links, 'comments-pagination', __( 'Comments navigation' ) );
+        }
+
+        return $navigation;
+}
+
+/**
+ * Display a paginated navigation to next/previous set of comments,
+ * when applicable.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args See {@see get_the_comments_pagination()} for available arguments.
+ */
+function the_comments_pagination( $args = array() ) {
+        echo get_the_comments_pagination( $args );
+}
+
+/**
  * Retrieve the Press This bookmarklet link.
  *
  * Use this in 'a' element 'href' attribute.