wp_list_comments() WP 1.0

List comments. Used in the comments.php template to list comments for a particular post.

Used in the comments.php template to list comments for a particular post.

Return

Null. Nothing.

Usage

wp_list_comments( $args, $comments );

$args(string/array)

Formatting options.

• $walker (object)
  Instance of a Walker class to list comments.
  Default: null

• $max_depth (int)
  The maximum comments depth.
  Default: ''

• $style (string)
  The style of list ordering. Accepts 'ul', 'ol'.
  Default: 'ul'

• $callback (string)
  Callback function to use.
  Default: null

• $end-callback (string)
  Callback function to use at the end.
  Default: null

• $type (string)
  Type of comments to list. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'.
  Default: 'all'

• $page (int)
  Page ID to list comments for.
  Default: ''

• $per_page (int)
  Number of comments to list per page.
  Default: ''

• $avatar_size (int)
  Height and width dimensions of the avatar size.
  Default: 32

• $reverse_top_level (true/false)
  Ordering of the listed comments. If true, will display newest comments first.

• $reverse_children (true/false)
  Whether to reverse child comments in the list.
  Default: null

• $format (string)
  How to format the comments list. if the theme supports it. Accepts 'html5', 'xhtml'.
  Default: 'html5'

• $short_ping (true/false)
  Whether to output short pings.
  Default: false

• $echo (true/false)
  Whether to echo the output or return it.
  Default: true

Default: array()

$comments(array)

Array of WP_Comment objects.
Default: null

Notes

• See: WP_Query->comments
• Global. WP_Query. $wp_query
• Global. Int. $comment_alt
• Global. Int. $comment_depth
• Global. Int. $comment_thread_alt
• Global. true/false. $overridden_cpage
• Global. true/false. $in_comment_loop

Changelog

Code of wp list comments: wp-includes/comment-template.php ^{WP 5.2.2}

<?php
function wp_list_comments( $args = array(), $comments = null ) {
	global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;

	$in_comment_loop = true;

	$comment_alt   = $comment_thread_alt = 0;
	$comment_depth = 1;

	$defaults = array(
		'walker'            => null,
		'max_depth'         => '',
		'style'             => 'ul',
		'callback'          => null,
		'end-callback'      => null,
		'type'              => 'all',
		'page'              => '',
		'per_page'          => '',
		'avatar_size'       => 32,
		'reverse_top_level' => null,
		'reverse_children'  => '',
		'format'            => current_theme_supports( 'html5', 'comment-list' ) ? 'html5' : 'xhtml',
		'short_ping'        => false,
		'echo'              => true,
	);

	$r = wp_parse_args( $args, $defaults );

	/**
	 * Filters the arguments used in retrieving the comment list.
	 *
	 * @since 4.0.0
	 *
	 * @see wp_list_comments()
	 *
	 * @param array $r An array of arguments for displaying comments.
	 */
	$r = apply_filters( 'wp_list_comments_args', $r );

	// Figure out what comments we'll be looping through ($_comments)
	if ( null !== $comments ) {
		$comments = (array) $comments;
		if ( empty( $comments ) ) {
			return;
		}
		if ( 'all' != $r['type'] ) {
			$comments_by_type = separate_comments( $comments );
			if ( empty( $comments_by_type[ $r['type'] ] ) ) {
				return;
			}
			$_comments = $comments_by_type[ $r['type'] ];
		} else {
			$_comments = $comments;
		}
	} else {
		/*
		 * If 'page' or 'per_page' has been passed, and does not match what's in $wp_query,
		 * perform a separate comment query and allow Walker_Comment to paginate.
		 */
		if ( $r['page'] || $r['per_page'] ) {
			$current_cpage = get_query_var( 'cpage' );
			if ( ! $current_cpage ) {
				$current_cpage = 'newest' === get_option( 'default_comments_page' ) ? 1 : $wp_query->max_num_comment_pages;
			}

			$current_per_page = get_query_var( 'comments_per_page' );
			if ( $r['page'] != $current_cpage || $r['per_page'] != $current_per_page ) {
				$comment_args = array(
					'post_id' => get_the_ID(),
					'orderby' => 'comment_date_gmt',
					'order'   => 'ASC',
					'status'  => 'approve',
				);

				if ( is_user_logged_in() ) {
					$comment_args['include_unapproved'] = get_current_user_id();
				} else {
					$unapproved_email = wp_get_unapproved_comment_author_email();

					if ( $unapproved_email ) {
						$comment_args['include_unapproved'] = array( $unapproved_email );
					}
				}

				$comments = get_comments( $comment_args );

				if ( 'all' != $r['type'] ) {
					$comments_by_type = separate_comments( $comments );
					if ( empty( $comments_by_type[ $r['type'] ] ) ) {
						return;
					}

					$_comments = $comments_by_type[ $r['type'] ];
				} else {
					$_comments = $comments;
				}
			}

			// Otherwise, fall back on the comments from `$wp_query->comments`.
		} else {
			if ( empty( $wp_query->comments ) ) {
				return;
			}
			if ( 'all' != $r['type'] ) {
				if ( empty( $wp_query->comments_by_type ) ) {
					$wp_query->comments_by_type = separate_comments( $wp_query->comments );
				}
				if ( empty( $wp_query->comments_by_type[ $r['type'] ] ) ) {
					return;
				}
				$_comments = $wp_query->comments_by_type[ $r['type'] ];
			} else {
				$_comments = $wp_query->comments;
			}

			if ( $wp_query->max_num_comment_pages ) {
				$default_comments_page = get_option( 'default_comments_page' );
				$cpage                 = get_query_var( 'cpage' );
				if ( 'newest' === $default_comments_page ) {
					$r['cpage'] = $cpage;

					/*
					* When first page shows oldest comments, post permalink is the same as
					* the comment permalink.
					*/
				} elseif ( $cpage == 1 ) {
					$r['cpage'] = '';
				} else {
					$r['cpage'] = $cpage;
				}

				$r['page']     = 0;
				$r['per_page'] = 0;
			}
		}
	}

	if ( '' === $r['per_page'] && get_option( 'page_comments' ) ) {
		$r['per_page'] = get_query_var( 'comments_per_page' );
	}

	if ( empty( $r['per_page'] ) ) {
		$r['per_page'] = 0;
		$r['page']     = 0;
	}

	if ( '' === $r['max_depth'] ) {
		if ( get_option( 'thread_comments' ) ) {
			$r['max_depth'] = get_option( 'thread_comments_depth' );
		} else {
			$r['max_depth'] = -1;
		}
	}

	if ( '' === $r['page'] ) {
		if ( empty( $overridden_cpage ) ) {
			$r['page'] = get_query_var( 'cpage' );
		} else {
			$threaded  = ( -1 != $r['max_depth'] );
			$r['page'] = ( 'newest' == get_option( 'default_comments_page' ) ) ? get_comment_pages_count( $_comments, $r['per_page'], $threaded ) : 1;
			set_query_var( 'cpage', $r['page'] );
		}
	}
	// Validation check
	$r['page'] = intval( $r['page'] );
	if ( 0 == $r['page'] && 0 != $r['per_page'] ) {
		$r['page'] = 1;
	}

	if ( null === $r['reverse_top_level'] ) {
		$r['reverse_top_level'] = ( 'desc' == get_option( 'comment_order' ) );
	}

	wp_queue_comments_for_comment_meta_lazyload( $_comments );

	if ( empty( $r['walker'] ) ) {
		$walker = new Walker_Comment;
	} else {
		$walker = $r['walker'];
	}

	$output = $walker->paged_walk( $_comments, $r['max_depth'], $r['page'], $r['per_page'], $r );

	$in_comment_loop = false;

	if ( $r['echo'] ) {
		echo $output;
	} else {
		return $output;
	}
}

Related Functions

From tag: List (wp_list)

More from category: Comments