Changeset 34686

Timestamp:

09/29/2015 05:10:10 AM (9 years ago)

Author:

wonderboymusic

Message:

Allow wp_get_archives() to accept post_type as an arg.

Adds unit test.

Fixes #21596.

Location:

trunk

Files:

• src/wp-includes/general-template.php (modified) (8 diffs)
• tests/phpunit/tests/functions/getArchives.php (modified) (1 diff)

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

@@ -1358 +1358 @@
  *
  * @since 1.2.0
+ * @since 4.4.0 $post_type arg was added.
  *
  * @see get_archives_link()
@@ -1384 +1385 @@
  *     @type string     $order           Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'.
  *                                       Default 'DESC'.
+ *     @type string     $post_type       Post type. Default 'post'.
  * }
  * @return string|void String when retrieving.
@@ -1395 +1397 @@
         'after' => '', 'show_post_count' => false,
         'echo' => 1, 'order' => 'DESC',
+        'post_type' => 'post'
     );
 
     $r = wp_parse_args( $args, $defaults );
+
+    $post_type_object = get_post_type_object( $r['post_type'] );
+    if ( ! is_post_type_viewable( $post_type_object ) ) {
+        return;
+    }
+    $r['post_type'] = $post_type_object->name;
 
     if ( '' == $r['type'] ) {
@@ -1440 +1449 @@
      * @param array  $r         An array of default arguments.
      */
-    $where = apply_filters( 'getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r );
+    $sql_where = $wpdb->prepare( "WHERE post_type = %s AND post_status = 'publish'", $r['post_type'] );
+    $where = apply_filters( 'getarchives_where', $sql_where, $r );
 
     /**
@@ -1474 +1484 @@
             foreach ( (array) $results as $result ) {
                 $url = get_month_link( $result->year, $result->month );
+                if ( 'post' !== $r['post_type'] ) {
+                    $url = add_query_arg( 'post_type', $r['post_type'], $url );
+                }
                 /* translators: 1: month name, 2: 4-digit year */
                 $text = sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $result->month ), $result->year );
@@ -1494 +1507 @@
             foreach ( (array) $results as $result) {
                 $url = get_year_link( $result->year );
+                if ( 'post' !== $r['post_type'] ) {
+                    $url = add_query_arg( 'post_type', $r['post_type'], $url );
+                }
                 $text = sprintf( '%d', $result->year );
                 if ( $r['show_post_count'] ) {
@@ -1513 +1529 @@
             foreach ( (array) $results as $result ) {
                 $url  = get_day_link( $result->year, $result->month, $result->dayofmonth );
+                if ( 'post' !== $r['post_type'] ) {
+                    $url = add_query_arg( 'post_type', $r['post_type'], $url );
+                }
                 $date = sprintf( '%1$d-%2$02d-%3$02d 00:00:00', $result->year, $result->month, $result->dayofmonth );
                 $text = mysql2date( $archive_day_date_format, $date );
@@ -1541 +1560 @@
                     $arc_week_end   = date_i18n( $archive_week_end_date_format, $arc_week['end'] );
                     $url            = sprintf( '%1$s/%2$s%3$sm%4$s%5$s%6$sw%7$s%8$d', home_url(), '', '?', '=', $arc_year, '&', '=', $result->week );
+                    if ( 'post' !== $r['post_type'] ) {
+                        $url = add_query_arg( 'post_type', $r['post_type'], $url );
+                    }
                     $text           = $arc_week_start . $archive_week_separator . $arc_week_end;
                     if ( $r['show_post_count'] ) {

trunk/tests/phpunit/tests/functions/getArchives.php

@@ -89 +89 @@
         $this->assertEquals( $expected['order_desc'], trim( wp_get_archives( array( 'echo' => false, 'order' => 'DESC' ) ) ) );
     }
+
+    /**
+     * @ticket 21596
+     */
+    function test_wp_get_archives_post_type() {
+        register_post_type( 'taco', array( 'public' => true ) );
+
+        $this->factory->post->create( array(
+            'post_type' => 'taco',
+            'post_author' => '1',
+            'post_date' => '2014-10-23 19:34:42'
+        ) );
+
+        $oct_url = esc_url( add_query_arg( 'post_type', 'taco', get_month_link( 2014, 10 ) ) );
+        $expected = "<li><a href='{$oct_url}'>October 2014</a></li>";
+        $archives = wp_get_archives( array( 'echo' => false, 'post_type' => 'taco' ) );
+        $this->assertEquals( $expected, trim( $archives ) );
+    }
 }