Changeset 28379

Timestamp:

05/13/2014 04:28:56 AM (7 years ago)

Author:

wonderboymusic

Message:

Eliminate use of extract() in wp_get_archives().

Adds unit tests: tests/functions/getArchives.php.
All other unit tests pass.

Props MikeHansenMe, wonderboymusic.
See #22400.

Location:

trunk

Files:

• src/wp-includes/general-template.php (modified) (11 diffs)
• tests/phpunit/tests/functions/getArchives.php (added)

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

@@ -1174 +1174 @@
  * @return string|null String when retrieving, null when displaying.
  */
-function wp_get_archives($args = '') {
+function wp_get_archives( $args = '' ) {
     global $wpdb, $wp_locale;
 
@@ -1185 +1185 @@
 
     $r = wp_parse_args( $args, $defaults );
-    extract( $r, EXTR_SKIP );
-
-    if ( '' == $type )
-        $type = 'monthly';
-
-    if ( '' != $limit ) {
-        $limit = absint($limit);
-        $limit = ' LIMIT '.$limit;
-    }
-
-    $order = strtoupper( $order );
-    if ( $order !== 'ASC' )
+
+    if ( '' == $r['type'] ) {
+        $r['type'] = 'monthly';
+    }
+
+    if ( '' != $r['limit'] ) {
+        $r['limit'] = absint( $r['limit'] );
+        $r['limit'] = ' LIMIT ' . $r['limit'];
+    }
+
+    $order = strtoupper( $r['order'] );
+    if ( $order !== 'ASC' ) {
         $order = 'DESC';
+    }
 
     // this is what will separate dates on weekly archive links
@@ -1212 +1213 @@
     $archive_week_end_date_format   = 'Y/m/d';
 
-    if ( !$archive_date_format_over_ride ) {
-        $archive_day_date_format = get_option('date_format');
-        $archive_week_start_date_format = get_option('date_format');
-        $archive_week_end_date_format = get_option('date_format');
+    if ( ! $archive_date_format_over_ride ) {
+        $archive_day_date_format = get_option( 'date_format' );
+        $archive_week_start_date_format = get_option( 'date_format' );
+        $archive_week_end_date_format = get_option( 'date_format' );
     }
 
@@ -1246 +1247 @@
     }
 
-    if ( 'monthly' == $type ) {
+    $limit = $r['limit'];
+
+    if ( 'monthly' == $r['type'] ) {
         $query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date) ORDER BY post_date $order $limit";
         $key = md5( $query );
@@ -1255 +1258 @@
         }
         if ( $results ) {
-            $afterafter = $after;
+            $after = $r['after'];
             foreach ( (array) $results as $result ) {
                 $url = get_month_link( $result->year, $result->month );
                 /* translators: 1: month name, 2: 4-digit year */
-                $text = sprintf(__('%1$s %2$d'), $wp_locale->get_month($result->month), $result->year);
-                if ( $show_post_count )
-                    $after = ' ('.$result->posts.')' . $afterafter;
-                $output .= get_archives_link($url, $text, $format, $before, $after);
+                $text = sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $result->month ), $result->year );
+                if ( $r['show_post_count'] ) {
+                    $after = ' ('.$result->posts.')' . $after;
+                }
+                $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $after );
             }
         }
-    } elseif ('yearly' == $type) {
+    } elseif ( 'yearly' == $r['type'] ) {
         $query = "SELECT YEAR(post_date) AS `year`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date) ORDER BY post_date $order $limit";
         $key = md5( $query );
@@ -1274 +1278 @@
         }
         if ( $results ) {
-            $afterafter = $after;
+            $after = $r['after'];
             foreach ( (array) $results as $result) {
-                $url = get_year_link($result->year);
-                $text = sprintf('%d', $result->year);
-                if ($show_post_count)
-                    $after = ' ('.$result->posts.')' . $afterafter;
-                $output .= get_archives_link($url, $text, $format, $before, $after);
+                $url = get_year_link( $result->year );
+                $text = sprintf( '%d', $result->year );
+                if ( $r['show_post_count'] ) {
+                    $r['after'] = ' ('.$result->posts.')' . $after;
+                }
+                $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
             }
         }
-    } elseif ( 'daily' == $type ) {
+    } elseif ( 'daily' == $r['type'] ) {
         $query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, DAYOFMONTH(post_date) AS `dayofmonth`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date), DAYOFMONTH(post_date) ORDER BY post_date $order $limit";
         $key = md5( $query );
@@ -1293 +1298 @@
         }
         if ( $results ) {
-            $afterafter = $after;
+            $after = $r['after'];
             foreach ( (array) $results as $result ) {
-                $url    = get_day_link($result->year, $result->month, $result->dayofmonth);
-                $date = sprintf('%1$d-%2$02d-%3$02d 00:00:00', $result->year, $result->month, $result->dayofmonth);
-                $text = mysql2date($archive_day_date_format, $date);
-                if ($show_post_count)
-                    $after = ' ('.$result->posts.')'.$afterafter;
-                $output .= get_archives_link($url, $text, $format, $before, $after);
+                $url    = get_day_link( $result->year, $result->month, $result->dayofmonth );
+                $date = sprintf( '%1$d-%2$02d-%3$02d 00:00:00', $result->year, $result->month, $result->dayofmonth );
+                $text = mysql2date( $archive_day_date_format, $date );
+                if ( $r['show_post_count'] ) {
+                    $after = ' (' . $result->posts . ')' . $after;
+                }
+                $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $after );
             }
         }
-    } elseif ( 'weekly' == $type ) {
+    } elseif ( 'weekly' == $r['type'] ) {
         $week = _wp_mysql_week( '`post_date`' );
         $query = "SELECT DISTINCT $week AS `week`, YEAR( `post_date` ) AS `yr`, DATE_FORMAT( `post_date`, '%Y-%m-%d' ) AS `yyyymmdd`, count( `ID` ) AS `posts` FROM `$wpdb->posts` $join $where GROUP BY $week, YEAR( `post_date` ) ORDER BY `post_date` $order $limit";
@@ -1313 +1319 @@
         }
         $arc_w_last = '';
-        $afterafter = $after;
+        $after = $r['after'];
         if ( $results ) {
                 foreach ( (array) $results as $result ) {
@@ -1319 +1325 @@
                         $arc_year = $result->yr;
                         $arc_w_last = $result->week;
-                        $arc_week = get_weekstartend($result->yyyymmdd, get_option('start_of_week'));
-                        $arc_week_start = date_i18n($archive_week_start_date_format, $arc_week['start']);
-                        $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);
+                        $arc_week = get_weekstartend( $result->yyyymmdd, get_option( 'start_of_week' ) );
+                        $arc_week_start = date_i18n( $archive_week_start_date_format, $arc_week['start'] );
+                        $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 );
                         $text = $arc_week_start . $archive_week_separator . $arc_week_end;
-                        if ($show_post_count)
-                            $after = ' ('.$result->posts.')'.$afterafter;
-                        $output .= get_archives_link($url, $text, $format, $before, $after);
+                        if ( $r['show_post_count'] ) {
+                            $after = ' (' . $result->posts . ')' . $after;
+                        }
+                        $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $after );
                     }
                 }
         }
-    } elseif ( ( 'postbypost' == $type ) || ('alpha' == $type) ) {
-        $orderby = ('alpha' == $type) ? 'post_title ASC ' : 'post_date DESC ';
+    } elseif ( ( 'postbypost' == $r['type'] ) || ('alpha' == $r['type'] ) ) {
+        $orderby = ( 'alpha' == $r['type'] ) ? 'post_title ASC ' : 'post_date DESC ';
         $query = "SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit";
         $key = md5( $query );
@@ -1349 +1356 @@
                         $text = $result->ID;
                     }
-                    $output .= get_archives_link($url, $text, $format, $before, $after);
+                    $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
                 }
             }
         }
     }
-    if ( $echo )
+    if ( $r['echo'] ) {
         echo $output;
-    else
+    } else {
         return $output;
+    }
 }
 
@@ -2510 +2518 @@
             $r .= "</li>\n</ul>\n";
             break;
-        
+
         default :
             $r = join("\n", $page_links);