Changeset 8961

Timestamp:

09/23/2008 09:11:27 PM (16 years ago)

Author:

ryan

Message:

First cut of comment paging. Add paging and threading settings. see #7769 #7635

Location:

trunk

Files:

• wp-admin/options-discussion.php (modified) (1 diff)
• wp-admin/options.php (modified) (1 diff)
• wp-content/themes/default/comments.php (modified) (1 diff)
• wp-includes/classes.php (modified) (8 diffs)
• wp-includes/comment-template.php (modified) (3 diffs)
• wp-includes/formatting.php (modified) (1 diff)
• wp-includes/link-template.php (modified) (1 diff)
• wp-includes/query.php (modified) (2 diffs)

trunk/wp-admin/options-discussion.php

@@ -40 +40 @@
 <input name="close_comments_for_old_posts" type="checkbox" id="close_comments_for_old_posts" value="1" <?php checked('1', get_option('close_comments_for_old_posts')); ?> />
 <?php _e('Close comments on articles older than') ?></label> <?php printf(__('%s days'), '<input name="close_comments_days_old" type="text" id="close_comments_days_old" value="' . attribute_escape(get_option('close_comments_days_old')) . '" size="3" />') ?>
+<br />
+<label for="thread_comments">
+<input name="thread_comments" type="checkbox" id="thread_comments" value="1" <?php checked('1', get_option('thread_comments')); ?> />
+<?php _e('Group replies into threads') ?></label> <?php printf(__('%s levels deep'), '<input name="thread_comments_depth" type="text" id="thread_comments_depth" value="' . attribute_escape(get_option('thread_comments_depth')) . '" size="3" />') ?>
+<br />
+<label for="page_comments">
+<input name="page_comments" type="checkbox" id="page_comments" value="1" <?php checked('1', get_option('page_comments')); ?> />
+<?php _e('Break comments into pages with') ?></label> <?php printf(__('%s comments per page'), '<input name="comments_per_page" type="text" id="comments_per_page" value="' . attribute_escape(get_option('comments_per_page')) . '" size="3" />') ?>
 <br />
 <small><em><?php echo '(' . __('These settings may be overridden for individual articles.') . ')'; ?></em></small>

trunk/wp-admin/options.php

@@ -24 +24 @@
 $whitelist_options = array(
     'general' => array('blogname', 'blogdescription', 'admin_email', 'users_can_register', 'gmt_offset', 'date_format', 'time_format', 'start_of_week', 'comment_registration', 'default_role' ),
-    'discussion' => array( 'default_pingback_flag', 'default_ping_status', 'default_comment_status', 'comments_notify', 'moderation_notify', 'comment_moderation', 'require_name_email', 'comment_whitelist', 'comment_max_links', 'moderation_keys', 'blacklist_keys', 'show_avatars', 'avatar_rating', 'close_comments_for_old_posts', 'close_comments_days_old' ),
+    'discussion' => array( 'default_pingback_flag', 'default_ping_status', 'default_comment_status', 'comments_notify', 'moderation_notify', 'comment_moderation', 'require_name_email', 'comment_whitelist', 'comment_max_links', 'moderation_keys', 'blacklist_keys', 'show_avatars', 'avatar_rating', 'close_comments_for_old_posts', 'close_comments_days_old', 'thread_comments', 'thread_comments_depth', 'page_comments', 'comments_per_page' ),
     'misc' => array( 'hack_file', 'use_linksupdate', 'uploads_use_yearmonth_folders', 'upload_path' ),
     'media' => array( 'thumbnail_size_w', 'thumbnail_size_h', 'thumbnail_crop', 'medium_size_w', 'medium_size_h', 'large_size_w', 'large_size_h', 'image_default_size', 'image_default_align', 'image_default_link_type' ),

trunk/wp-content/themes/default/comments.php

@@ -16 +16 @@
 
     <ol class="commentlist">
-    <?php wp_list_comments($comments); ?>
+    <?php wp_list_comments(); ?>
     </ol>
-
+    <div class="navigation">
+        <div class="alignleft"><?php previous_comments_link() ?></div>
+        <div class="alignright"><?php next_comments_link() ?></div>
+    </div>
  <?php else : // this is displayed if there are no comments so far ?>
 

trunk/wp-includes/classes.php

@@ -27 +27 @@
      * @var array
      */
-    var $public_query_vars = array('m', 'p', 'posts', 'w', 'cat', 'withcomments', 'withoutcomments', 's', 'search', 'exact', 'sentence', 'debug', 'calendar', 'page', 'paged', 'more', 'tb', 'pb', 'author', 'order', 'orderby', 'year', 'monthnum', 'day', 'hour', 'minute', 'second', 'name', 'category_name', 'tag', 'feed', 'author_name', 'static', 'pagename', 'page_id', 'error', 'comments_popup', 'attachment', 'attachment_id', 'subpost', 'subpost_id', 'preview', 'robots', 'taxonomy', 'term');
+    var $public_query_vars = array('m', 'p', 'posts', 'w', 'cat', 'withcomments', 'withoutcomments', 's', 'search', 'exact', 'sentence', 'debug', 'calendar', 'page', 'paged', 'more', 'tb', 'pb', 'author', 'order', 'orderby', 'year', 'monthnum', 'day', 'hour', 'minute', 'second', 'name', 'category_name', 'tag', 'feed', 'author_name', 'static', 'pagename', 'page_id', 'error', 'comments_popup', 'attachment', 'attachment_id', 'subpost', 'subpost_id', 'preview', 'robots', 'taxonomy', 'term', 'cpage');
 
     /**
@@ -37 +37 @@
      * @var array
      */
-    var $private_query_vars = array('offset', 'posts_per_page', 'posts_per_archive_page', 'what_to_show', 'showposts', 'nopaging', 'post_type', 'post_status', 'category__in', 'category__not_in', 'category__and', 'tag__in', 'tag__not_in', 'tag__and', 'tag_slug__in', 'tag_slug__and', 'tag_id', 'post_mime_type', 'perm');
+    var $private_query_vars = array('offset', 'posts_per_page', 'posts_per_archive_page', 'what_to_show', 'showposts', 'nopaging', 'post_type', 'post_status', 'category__in', 'category__not_in', 'category__and', 'tag__in', 'tag__not_in', 'tag__and', 'tag_slug__in', 'tag_slug__and', 'tag_id', 'post_mime_type', 'perm', 'comments_per_page');
 
     /**
@@ -732 +732 @@
 
     /**
+     * Max number of pages walked by the paged walker 
+     *
+     * @since 2.7.0
+     * @var int
+     * @access protected
+     */
+    var $max_pages = 1;
+
+    /**
      * Starts the list before the elements are added.
      *
@@ -948 +957 @@
 
         /* sanity check */
-        if ( empty($elements) || $max_depth < 0 )
+        if ( empty($elements) || $max_depth < -1 )
             return '';
 
@@ -956 +965 @@
         $id_field = $this->db_fields['id'];
         $parent_field = $this->db_fields['parent'];
+
+        $count = -1;
+        if ( -1 == $max_depth )
+            $total_top = count( $elements );
+        if ( $page_num < 1 || $per_page < 0  ) {
+            // No paging
+            $paging = false;
+            $start = 0;
+            if ( -1 == $max_depth )
+                $end = $total_top;
+            $this->max_pages = 1;
+        } else {
+            $paging = true;
+            $start = ( (int)$page_num - 1 ) * (int)$per_page;
+            $end   = $start + $per_page;
+            if ( -1 == $max_depth )
+                $this->max_pages = ceil($total_top / $per_page);
+        }
+
+        // flat display
+        if ( -1 == $max_depth ) {
+            $empty_array = array();
+            foreach ( $elements as $e ) {
+                $count++;
+                if ( $count < $start )
+                    continue;
+                if ( $count >= $end )
+                    break;
+                $this->display_element( $e, $empty_array, 1, 0, $args, $output );
+            }
+            return $output;
+        }
 
         /*
@@ -971 +1012 @@
         }
 
-        $count = -1;
         $total_top = count( $top_level_elements );
-        if ( $page_num < 1 || $per_page < 0  ) {
-            $start = 0;
-            $end = $total_top;
-        } else {
-            $start = ( (int)$page_num - 1 ) * (int)$per_page;
-            $end   = $start + $per_page;
-        }
+
+        if ( $paging )
+            $this->max_pages = ceil($total_top / $per_page);
 
         foreach( $top_level_elements as $e ){
@@ -997 +1033 @@
         }
 
-        if ( $end >= $total_top && count( $children_elements ) > 0 ){
+        if ( $end >= $total_top && count( $children_elements ) > 0 ) {
             $empty_array = array();
             foreach ( $children_elements as $orphans )
@@ -1031 +1067 @@
             $this->unset_children( $child, $children_elements );
 
-        unset( $children_elements[$id] );
+        if ( isset($children_elements[$id]) )
+            unset( $children_elements[$id] );
 
     }

trunk/wp-includes/comment-template.php

@@ -851 +851 @@
     $args = wp_parse_args($args, $defaults);
 
-    if ( 0 == $args['depth'] || $args['max_depth'] < $args['depth'] )
+    if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] )
         return;
 
@@ -974 +974 @@
  *
  * @param $args string|array Formatting options
-    * @param $comments array Optional array of comment objects.  Defaults to $wp_query->comments
+ * @param $comments array Optional array of comment objects.  Defaults to $wp_query->comments
  */
 function wp_list_comments($args = array(), $comments = null ) {
     global $wp_query;
 
-    $defaults = array('walker' => null, 'depth' => 3, 'style' => 'ul', 'callback' => null, 'end-callback' => null, 'type' => 'all');
+    $defaults = array('walker' => null, 'depth' => '', 'style' => 'ul', 'callback' => null, 'end-callback' => null, 'type' => 'all',
+        'page' => get_query_var('cpage'), 'per_page' => '');
 
     $r = wp_parse_args( $args, $defaults );
+
+    if ( '' === $r['per_page'] && get_option('page_comments') )
+        $r['per_page'] = get_query_var('comments_per_page');
+
+    if ( empty($r['per_page']) ) {
+        $r['page'] = 0;
+    } else {
+        $r['page'] = intval($r['page']);
+        if ( empty($r['page']) )
+            $r['page'] = 1;
+    }
+
+    if ( '' === $r['depth'] ) {
+        if ( get_option('thread_comments') )
+            $r['depth'] = get_option('thread_comments_depth');
+        else
+            $r['depth'] = -1;
+    }
 
     extract( $r, EXTR_SKIP );
@@ -996 +1015 @@
             if ( empty($wp_query->comments_by_type[$type]) )
                 return;
-            return $walker->walk($wp_query->comments_by_type[$type], $depth, $r);
+            $walker->paged_walk($wp_query->comments_by_type[$type], $depth, $page, $per_page, $r);
+            $wp_query->max_num_comment_pages = $walker->max_pages;
+            return;
         }
-        $walker->walk($wp_query->comments, $depth, $r);
+        $walker->paged_walk($wp_query->comments, $depth, $page, $per_page, $r);
+        $wp_query->max_num_comment_pages = $walker->max_pages;
     } else {
         if ( empty($comments) )
             return;
         if ( 'all' != $type ) {
-            $comments_by_type = separate_comments($comments);
+            $comments_by_type = &separate_comments($comments);
             if ( empty($comments_by_type[$type]) )
                 return;
-            return $walker->walk($comments_by_type[$type], $depth, $r);
+            $walker->paged_walk($comments_by_type[$type], $depth, $page, $per_page, $r);
+            $wp_query->max_num_comment_pages = $walker->max_pages;
+            return;
         }
-        $walker->walk($comments, $depth, $r);
+        $walker->paged_walk($comments, $depth, $page, $per_page, $r);
+        $wp_query->max_num_comment_pages = $walker->max_pages;
     }
 }

trunk/wp-includes/formatting.php

@@ -1821 +1821 @@
         case 'default_email_category':
         case 'default_link_category':
+        case 'close_comments_days_old':
+        case 'comments_per_page':
+        case 'thread_comments_depth':
             $value = abs((int) $value);
             break;

trunk/wp-includes/link-template.php

@@ -794 +794 @@
 }
 
+function get_comments_pagenum_link($pagenum = 1) {
+    global $wp_rewrite;
+
+    $pagenum = (int) $pagenum;
+
+    $request = remove_query_arg( 'cpage' );
+
+    $home_root = parse_url(get_option('home'));
+    $home_root = ( isset($home_root['path']) ) ? $home_root['path'] : '';
+    $home_root = preg_quote( trailingslashit( $home_root ), '|' );
+
+    $request = preg_replace('|^'. $home_root . '|', '', $request);
+    $request = preg_replace('|^/+|', '', $request);
+
+    $base = trailingslashit( get_bloginfo( 'home' ) );
+
+    if ( $pagenum > 1 ) {
+        $result = add_query_arg( 'cpage', $pagenum, $base . $request );
+    } else {
+        $result = $base . $request;
+    }
+
+    $result = apply_filters('get_comments_pagenum_link', $result);
+
+    return $result;
+}
+
+function next_comments_link($label='', $max_page = 0) {
+    global $wp_query;
+
+    if ( !is_singular() )
+        return;
+
+    $page = get_query_var('cpage');
+    
+    if ( !$page )
+        $page = 1;
+
+    if ( !$page )
+        $page = 1;
+
+    $nextpage = intval($page) + 1;
+
+    if ( empty($max_page) )
+        $max_page = $wp_query->max_num_comment_pages;
+
+    if ( $nextpage > $max_page )
+        return;
+
+    if ( empty($label) )
+        $label = __('» Newer Comments');
+
+    echo '<a href="' . clean_url(get_comments_pagenum_link($nextpage));
+    $attr = apply_filters( 'next_comments_link_attributes', '' );
+    echo "\" $attr>". preg_replace('/&([^#])(?![a-z]{1,8};)/', '&#038;$1', $label) .'</a>';
+}
+
+function previous_comments_link($label='') {
+    global $wp_query;
+
+    if ( !is_singular() )
+        return;
+
+    $page = get_query_var('cpage');
+
+    if ( $page <= 1 )
+        return;
+
+    $nextpage = intval($page) - 1;
+
+    if ( empty($label) )
+        $label = __('&laquo; Older Comments');
+
+    echo '<a href="' . clean_url(get_comments_pagenum_link($nextpage));
+    $attr = apply_filters( 'previous_comments_link_attributes', '' );
+    echo "\" $attr>". preg_replace('/&([^#])(?![a-z]{1,8};)/', '&#038;$1', $label) .'</a>';
+}
+
 function get_shortcut_link() {
     $link = "javascript:

trunk/wp-includes/query.php

@@ -843 +843 @@
      */
     var $max_num_pages = 0;
+
+    /**
+     * The amount of comment pages.
+     *
+     * @since 2.7.0
+     * @access public
+     * @var int
+     */
+    var $max_num_comment_pages = 0;
 
     /**
@@ -1613 +1622 @@
             $q['posts_per_page'] = 1;
 
+        if ( !isset($q['comments_per_page']) || $q['comments_per_page'] == 0 )
+            $q['comments_per_page'] = get_option('comments_per_page');
+
         if ( $this->is_home && (empty($this->query) || $q['preview'] == 'true') && ( 'page' == get_option('show_on_front') ) && get_option('page_on_front') ) {
             $this->is_page = true;