wp_list_comments( string|array $args = array(), WP_Comment[] $comments = null ): void|string

Description

Parameters

$argsstring|arrayoptional

Formatting options.Default: array()

• $walkerobjectdefault: null

  Instance of a Walker class to list comments.

• $max_depthintdefault: empty

  The maximum comments depth.

• $stylestringdefault: 'ul'

  The style of list ordering. Accepts 'ul', 'ol', or 'div'. 'div' will result in no additional list markup.

• $callbackcallabledefault: null

  Callback function to use.

• $endcallabledefault: null

  -callback Callback function to use at the end.

• $typestringdefault: 'all'

  Type of comments to list. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'.

• $pageintdefault: empty

  Page ID to list comments for.

• $per_pageintdefault: empty

  Number of comments to list per page.

• $avatar_sizeintdefault: 32

  Height and width dimensions of the avatar size.

• $reverse_top_levelbooldefault: null

  Ordering of the listed comments. If true, will display newest comments first.

• $reverse_childrenbooldefault: null

  Whether to reverse child comments in the list.

• $formatstringdefault: 'html5' if the theme supports it

  How to format the comments list. Accepts 'html5', 'xhtml'.

• $short_pingbooldefault: false

  Whether to output short pings.

• $echobooldefault: true

  Whether to echo the output or return it.

$commentsWP_Comment[]optional

Array of WP_Comment objects. Default null.Default: null

Return

void|string

Void if 'echo' argument is true, or no comments to list. Otherwise, HTML list of comments.

Hooks fired · 1

One hook fires while wp_list_comments() runs, in this order:

1. 1
   apply_filters( wp_list_comments_args )filterline 2274 (+37 into the body)

   Filters the arguments used in retrieving the comment list.

Uses · 14

• current_theme_supports()Checks a theme's support for a given feature.
• wp_parse_args()Merges user defined arguments into defaults array.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• separate_comments()Separates an array of comments into an array keyed by comment_type.
• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• get_option()Retrieves an option value based on an option name.
• get_the_ID()Retrieves the ID of the current item in the WordPress Loop.
• is_user_logged_in()Determines whether the current visitor is a logged in user.
• get_current_user_id()Gets the current user's ID.
• wp_get_unapproved_comment_author_email()Gets unapproved comment author's email.
• get_comments()Retrieves a list of comments.
• get_comment_pages_count()Calculates the total number of comment pages.

Source

View on Trac ↗View on GitHub ↗

2237function wp_list_comments( $args = array(), $comments = null ) {2238	global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;2239 2240	$in_comment_loop = true;2241 2242	$comment_alt        = 0;2243	$comment_thread_alt = 0;2244	$comment_depth      = 1;2245 2246	$defaults = array(2247		'walker'            => null,2248		'max_depth'         => '',2249		'style'             => 'ul',2250		'callback'          => null,2251		'end-callback'      => null,2252		'type'              => 'all',2253		'page'              => '',2254		'per_page'          => '',2255		'avatar_size'       => 32,2256		'reverse_top_level' => null,2257		'reverse_children'  => '',2258		'format'            => current_theme_supports( 'html5', 'comment-list' ) ? 'html5' : 'xhtml',2259		'short_ping'        => false,2260		'echo'              => true,2261	);2262 2263	$parsed_args = wp_parse_args( $args, $defaults );2264 2265	/**2266	 * Filters the arguments used in retrieving the comment list.2267	 *2268	 * @since 4.0.02269	 *2270	 * @see wp_list_comments()2271	 *2272	 * @param array $parsed_args An array of arguments for displaying comments.2273	 */2274	$parsed_args = apply_filters( 'wp_list_comments_args', $parsed_args );2275 2276	// Figure out what comments we'll be looping through ($_comments).2277	if ( null !== $comments ) {2278		$comments = (array) $comments;2279		if ( empty( $comments ) ) {2280			return;2281		}2282		if ( 'all' !== $parsed_args['type'] ) {2283			$comments_by_type = separate_comments( $comments );2284			if ( empty( $comments_by_type[ $parsed_args['type'] ] ) ) {2285				return;2286			}2287			$_comments = $comments_by_type[ $parsed_args['type'] ];2288		} else {2289			$_comments = $comments;2290		}2291	} else {2292		/*2293		 * If 'page' or 'per_page' has been passed, and does not match what's in $wp_query,2294		 * perform a separate comment query and allow Walker_Comment to paginate.2295		 */2296		if ( $parsed_args['page'] || $parsed_args['per_page'] ) {2297			$current_cpage = (int) get_query_var( 'cpage' );2298			if ( ! $current_cpage ) {2299				$current_cpage = 'newest' === get_option( 'default_comments_page' ) ? 1 : $wp_query->max_num_comment_pages;2300			}2301 2302			$current_per_page = (int) get_query_var( 'comments_per_page' );2303			if ( (int) $parsed_args['page'] !== $current_cpage || (int) $parsed_args['per_page'] !== $current_per_page ) {2304				$comment_args = array(2305					'post_id' => get_the_ID(),2306					'orderby' => 'comment_date_gmt',2307					'order'   => 'ASC',2308					'status'  => 'approve',2309				);2310 2311				if ( is_user_logged_in() ) {2312					$comment_args['include_unapproved'] = array( get_current_user_id() );2313				} else {2314					$unapproved_email = wp_get_unapproved_comment_author_email();2315 2316					if ( $unapproved_email ) {

History

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/comment-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.