Ensure that a `has_children` parameter is given to `Walker::start_el()`.

Adds unit tests.

Props scribu, obenland.
Fixes #14041.


git-svn-id: https://develop.svn.wordpress.org/trunk@28824 602fd350-edb4-49c9-b593-d223f7449a82

src/wp-includes/class-wp-walker.php

@@ -39,6 +39,15 @@ class Walker {
 	 */
 	protected $max_pages = 1;
 
+	/**
+	 * Wether the current element has children or not. To be used in start_el()
+	 *
+	 * @since 4.0.0
+	 * @var bool
+	 * @access protected
+	 */
+	protected $has_children;
+
 	/**
 	 * Make private properties readable for backwards compatibility
 	 *
@@ -172,15 +181,17 @@ class Walker {
 			return;
 
 		$id_field = $this->db_fields['id'];
+		$id       = $element->$id_field;
 
 		//display this element
-		if ( isset( $args[0] ) && is_array( $args[0] ) )
+		$this->has_children = ! empty( $children_elements[ $id ] );
-			$args[0]['has_children'] = ! empty( $children_elements[$element->$id_field] );
+		if ( isset( $args[0] ) && is_array( $args[0] ) ) {
+			$args[0]['has_children'] = $this->has_children; // Backwards compatibility.
+		}
+
 		$cb_args = array_merge( array(&$output, $element, $depth), $args);
 		call_user_func_array(array($this, 'start_el'), $cb_args);
 
-		$id = $element->$id_field;
-
 		// descend only when the depth is right and there are childrens for this element
 		if ( ($max_depth == 0 || $max_depth > $depth+1 ) && isset( $children_elements[$id]) ) {
 

src/wp-includes/comment-template.php

@@ -1784,7 +1784,7 @@ class Walker_Comment extends Walker {
 			$add_below = 'div-comment';
 		}
 ?>
-		<<?php echo $tag; ?> <?php comment_class( empty( $args['has_children'] ) ? '' : 'parent' ); ?> id="comment-<?php comment_ID(); ?>">
+		<<?php echo $tag; ?> <?php comment_class( $this->has_children ? 'parent' : '' ); ?> id="comment-<?php comment_ID(); ?>">
 		<?php if ( 'div' != $args['style'] ) : ?>
 		<div id="div-comment-<?php comment_ID(); ?>" class="comment-body">
 		<?php endif; ?>
@@ -1830,7 +1830,7 @@ class Walker_Comment extends Walker {
 	protected function html5_comment( $comment, $depth, $args ) {
 		$tag = ( 'div' === $args['style'] ) ? 'div' : 'li';
 ?>
-		<<?php echo $tag; ?> id="comment-<?php comment_ID(); ?>" <?php comment_class( empty( $args['has_children'] ) ? '' : 'parent' ); ?>>
+		<<?php echo $tag; ?> id="comment-<?php comment_ID(); ?>" <?php comment_class( $this->has_children ? 'parent' : '' ); ?>>
 			<article id="div-comment-<?php comment_ID(); ?>" class="comment-body">
 				<footer class="comment-meta">
 					<div class="comment-author vcard">

tests/phpunit/tests/comment/walker.php

@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * @group comment
+ */
+class Tests_Comment_Walker extends WP_UnitTestCase {
+
+	function setUp() {
+		parent::setUp();
+
+		$this->post_id = $this->factory->post->create();
+	}
+
+	/**
+	 * @ticket 14041
+	 */
+	function test_has_children() {
+		$comment_parent = $this->factory->comment->create( array( 'comment_post_ID' => $this->post_id ) );
+		$comment_child  = $this->factory->comment->create( array( 'comment_post_ID' => $this->post_id, 'comment_parent' => $comment_parent ) );
+		$comment_parent = get_comment( $comment_parent );
+		$comment_child  = get_comment( $comment_child  );
+
+		$comment_walker   = new Walker_Comment();
+		$comment_callback = new Comment_Callback_Test( $this, $comment_walker );
+
+		wp_list_comments( array( 'callback' => array( $comment_callback, 'comment' ), 'walker' => $comment_walker, 'echo' => false ), array( $comment_parent, $comment_child ) );
+		wp_list_comments( array( 'callback' => array( $comment_callback, 'comment' ), 'walker' => $comment_walker, 'echo' => false ), array( $comment_child, $comment_parent ) );
+	}
+}
+
+class Comment_Callback_Test {
+	public function __construct( Tests_Comment_Walker $test_walker, Walker_Comment $walker ) {
+		$this->test_walker = $test_walker;
+		$this->walker      = $walker;
+	}
+
+	public function comment( $comment, $args, $depth ) {
+		if ( 1 == $depth ) {
+			$this->test_walker->assertTrue( $this->walker->has_children );
+			$this->test_walker->assertTrue( $args['has_children']       ); // Back compat
+		}
+
+		else if ( 2 == $depth ) {
+			$this->test_walker->assertFalse( $this->walker->has_children );
+			$this->test_walker->assertFalse( $args['has_children']       ); // Back compat
+		}
+	}
+}