Changeset 28397

Timestamp:

05/14/2014 10:28:08 PM (7 years ago)

Author:

wonderboymusic

Message:

Eliminate use of extract() in paginate_links(). Adds unit tests. Moves tests/general/template.php (which only had one method) to tests/general/paginateLinks.php.

See #22400.

Location:

trunk

Files:

• src/wp-includes/general-template.php (modified) (3 diffs)
• tests/phpunit/tests/general/paginateLinks.php (moved) (moved from trunk/tests/phpunit/tests/general/template.php) (2 diffs)

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

@@ -2448 +2448 @@
 
     $args = wp_parse_args( $args, $defaults );
-    extract($args, EXTR_SKIP);
 
     // Who knows what else people pass in $args
-    $total = (int) $total;
-    if ( $total < 2 )
+    $total = (int) $args['total'];
+    if ( $total < 2 ) {
         return;
-    $current  = (int) $current;
-    $end_size = 0  < (int) $end_size ? (int) $end_size : 1; // Out of bounds?  Make it the default.
-    $mid_size = 0 <= (int) $mid_size ? (int) $mid_size : 2;
-    $add_args = is_array($add_args) ? $add_args : false;
+    }
+    $current  = (int) $args['current'];
+    $end_size = (int) $args['end_size']; // Out of bounds?  Make it the default.
+    if ( $end_size < 1 ) {
+        $end_size = 1;
+    }
+    $mid_size = (int) $args['mid_size'];
+    if ( $mid_size < 0 ) {
+        $mid_size = 2;
+    }
+    $add_args = is_array( $args['add_args'] ) ? $args['add_args'] : false;
     $r = '';
     $page_links = array();
     $dots = false;
 
-    if ( $prev_next && $current && 1 < $current ) :
-        $link = str_replace('%_%', 2 == $current ? '' : $format, $base);
-        $link = str_replace('%#%', $current - 1, $link);
+    if ( $args['prev_next'] && $current && 1 < $current ) :
+        $link = str_replace( '%_%', 2 == $current ? '' : $args['format'], $args['base'] );
+        $link = str_replace( '%#%', $current - 1, $link );
         if ( $add_args )
             $link = add_query_arg( $add_args, $link );
-        $link .= $add_fragment;
+        $link .= $args['add_fragment'];
 
         /**
@@ -2476 +2482 @@
          * @param string $link The paginated link URL.
          */
-        $page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $prev_text . '</a>';
+        $page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['prev_text'] . '</a>';
     endif;
     for ( $n = 1; $n <= $total; $n++ ) :
         if ( $n == $current ) :
-            $page_links[] = "<span class='page-numbers current'>" . $before_page_number . number_format_i18n( $n ) . $after_page_number . "</span>";
+            $page_links[] = "<span class='page-numbers current'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</span>";
             $dots = true;
         else :
-            if ( $show_all || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
-                $link = str_replace('%_%', 1 == $n ? '' : $format, $base);
-                $link = str_replace('%#%', $n, $link);
+            if ( $args['show_all'] || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
+                $link = str_replace( '%_%', 1 == $n ? '' : $args['format'], $args['base'] );
+                $link = str_replace( '%#%', $n, $link );
                 if ( $add_args )
                     $link = add_query_arg( $add_args, $link );
-                $link .= $add_fragment;
+                $link .= $args['add_fragment'];
 
                 /** This filter is documented in wp-includes/general-template.php */
-                $page_links[] = "<a class='page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>" . $before_page_number . number_format_i18n( $n ) . $after_page_number . "</a>";
+                $page_links[] = "<a class='page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</a>";
                 $dots = true;
-            elseif ( $dots && !$show_all ) :
+            elseif ( $dots && ! $args['show_all'] ) :
                 $page_links[] = '<span class="page-numbers dots">' . __( '&hellip;' ) . '</span>';
                 $dots = false;
@@ -2499 +2505 @@
         endif;
     endfor;
-    if ( $prev_next && $current && ( $current < $total || -1 == $total ) ) :
-        $link = str_replace('%_%', $format, $base);
-        $link = str_replace('%#%', $current + 1, $link);
+    if ( $args['prev_next'] && $current && ( $current < $total || -1 == $total ) ) :
+        $link = str_replace( '%_%', $args['format'], $args['base'] );
+        $link = str_replace( '%#%', $current + 1, $link );
         if ( $add_args )
             $link = add_query_arg( $add_args, $link );
-        $link .= $add_fragment;
+        $link .= $args['add_fragment'];
 
         /** This filter is documented in wp-includes/general-template.php */
-        $page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $next_text . '</a>';
+        $page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['next_text'] . '</a>';
     endif;
-    switch ( $type ) {
+    switch ( $args['type'] ) {
         case 'array' :
             return $page_links;

trunk/tests/phpunit/tests/general/paginateLinks.php

@@ -1 +1 @@
 <?php
 
-class Tests_General_Template extends WP_UnitTestCase {
+class Tests_Paginate_Links extends WP_UnitTestCase {
 
     private $i18n_count = 0;
+
+    function test_defaults() {
+        $expected =<<<EXPECTED
+<a class='page-numbers' href=''>1</a>
+<span class="page-numbers dots">&hellip;</span>
+<a class='page-numbers' href='?page=50'>50</a>
+EXPECTED;
+
+        $links = paginate_links( array( 'total' => 50 ) );
+        $this->assertEquals( $expected, $links );
+    }
+
+    function test_format() {
+        $expected =<<<EXPECTED
+<a class='page-numbers' href=''>1</a>
+<span class="page-numbers dots">&hellip;</span>
+<a class='page-numbers' href='/page/50/'>50</a>
+EXPECTED;
+
+        $links = paginate_links( array( 'total' => 50, 'format' => '/page/%#%/' ) );
+        $this->assertEquals( $expected, $links );
+    }
+
+    function test_prev_next_false() {
+        $expected =<<<EXPECTED
+<a class='page-numbers' href=''>1</a>
+<span class='page-numbers current'>2</span>
+<a class='page-numbers' href='?page=3'>3</a>
+<a class='page-numbers' href='?page=4'>4</a>
+<span class="page-numbers dots">&hellip;</span>
+<a class='page-numbers' href='?page=50'>50</a>
+EXPECTED;
+
+        $links = paginate_links( array( 'total' => 50, 'prev_next' => false, 'current' => 2 ) );
+        $this->assertEquals( $expected, $links );
+    }
+
+    function test_prev_next_true() {
+        $expected =<<<EXPECTED
+<a class="prev page-numbers" href="">&laquo; Previous</a>
+<a class='page-numbers' href=''>1</a>
+<span class='page-numbers current'>2</span>
+<a class='page-numbers' href='?page=3'>3</a>
+<a class='page-numbers' href='?page=4'>4</a>
+<span class="page-numbers dots">&hellip;</span>
+<a class='page-numbers' href='?page=50'>50</a>
+<a class="next page-numbers" href="?page=3">Next &raquo;</a>
+EXPECTED;
+
+        $links = paginate_links( array( 'total' => 50, 'prev_next' => true, 'current' => 2 ) );
+        $this->assertEquals( $expected, $links );
+    }
 
     function increment_i18n_count() {
@@ -28 +80 @@
         remove_filter( 'number_format_i18n', array( $this, 'increment_i18n_count' ) );
     }
-
 }