Changeset 34715

Timestamp:

09/30/2015 03:40:52 AM (8 years ago)

Author:

DrewAPicture

Message:

Themes: Introduce three new arguments for get_the_post_navigation(), in_same_term, excluded_terms, and taxonomy.

The addition of these new arguments brings get_the_post_navigation() into argument parity with get_previous_post_link() and get_next_post_link(), both of which it wraps, and will allow for more flexibility in configuring the next and previous post links for simultaneous display in themes.

Props ChaseWiseman.
Fixes #32618.

File:

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

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

@@ -2338 +2338 @@
  *
  * @since 4.1.0
+ * @since 4.4.0 Introduced the `in_same_term`, `excluded_terms`, and `taxonomy` arguments.
  *
  * @param array $args {
  *     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 bool         $in_same_term       Whether link should be in a same taxonomy term. Default false.
+ *     @type array|string $excluded_terms     Array or comma-separated list of excluded term IDs. Default empty.
+ *     @type string       $taxonomy           Taxonomy, if `$in_same_term` is true. Default 'category'.
+ *     @type string       $screen_reader_text Screen reader text for nav element. Default 'Post navigation'.
  * }
  * @return string Markup for post links.
@@ -2352 +2356 @@
         'prev_text'          => '%title',
         'next_text'          => '%title',
+        'in_same_term'       => false,
+        'excluded_terms'     => '',
+        'taxonomy'           => 'category',
         'screen_reader_text' => __( 'Post navigation' ),
     ) );
 
     $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'] );
+
+    $previous = get_previous_post_link(
+        '<div class="nav-previous">%link</div>',
+        $args['prev_text'],
+        $args['in_same_term'],
+        $args['excluded_terms'],
+        $args['taxonomy']
+    );
+
+    $next = get_next_post_link(
+        '<div class="nav-next">%link</div>',
+        $args['next_text'],
+        $args['in_same_term'],
+        $args['excluded_terms'],
+        $args['taxonomy']
+    );
 
     // Only add markup if there's somewhere to navigate to.