|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* Comment API: Walker_Comment class |
|
4
|
|
|
* |
|
5
|
|
|
* @package WordPress |
|
6
|
|
|
* @subpackage Comments |
|
7
|
|
|
* @since 4.4.0 |
|
8
|
|
|
*/ |
|
9
|
|
|
|
|
10
|
|
|
/** |
|
11
|
|
|
* Core walker class used to create an HTML list of comments. |
|
12
|
|
|
* |
|
13
|
|
|
* @since 2.7.0 |
|
14
|
|
|
* |
|
15
|
|
|
* @see Walker |
|
16
|
|
|
*/ |
|
17
|
|
|
class Walker_Comment extends Walker { |
|
18
|
|
|
|
|
19
|
|
|
/** |
|
20
|
|
|
* What the class handles. |
|
21
|
|
|
* |
|
22
|
|
|
* @since 2.7.0 |
|
23
|
|
|
* @access public |
|
24
|
|
|
* @var string |
|
25
|
|
|
* |
|
26
|
|
|
* @see Walker::$tree_type |
|
27
|
|
|
*/ |
|
28
|
|
|
public $tree_type = 'comment'; |
|
29
|
|
|
|
|
30
|
|
|
/** |
|
31
|
|
|
* Database fields to use. |
|
32
|
|
|
* |
|
33
|
|
|
* @since 2.7.0 |
|
34
|
|
|
* @access public |
|
35
|
|
|
* @var array |
|
36
|
|
|
* |
|
37
|
|
|
* @see Walker::$db_fields |
|
38
|
|
|
* @todo Decouple this |
|
39
|
|
|
*/ |
|
40
|
|
|
public $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID'); |
|
41
|
|
|
|
|
42
|
|
|
/** |
|
43
|
|
|
* Starts the list before the elements are added. |
|
44
|
|
|
* |
|
45
|
|
|
* @since 2.7.0 |
|
46
|
|
|
* @access public |
|
47
|
|
|
* |
|
48
|
|
|
* @see Walker::start_lvl() |
|
49
|
|
|
* @global int $comment_depth |
|
50
|
|
|
* |
|
51
|
|
|
* @param string $output Passed by reference. Used to append additional content. |
|
52
|
|
|
* @param int $depth Optional. Depth of the current comment. Default 0. |
|
53
|
|
|
* @param array $args Optional. Uses 'style' argument for type of HTML list. Default empty array. |
|
54
|
|
|
*/ |
|
55
|
|
View Code Duplication |
public function start_lvl( &$output, $depth = 0, $args = array() ) { |
|
56
|
|
|
$GLOBALS['comment_depth'] = $depth + 1; |
|
57
|
|
|
|
|
58
|
|
|
switch ( $args['style'] ) { |
|
59
|
|
|
case 'div': |
|
60
|
|
|
break; |
|
61
|
|
|
case 'ol': |
|
62
|
|
|
$output .= '<ol class="children">' . "\n"; |
|
63
|
|
|
break; |
|
64
|
|
|
case 'ul': |
|
65
|
|
|
default: |
|
66
|
|
|
$output .= '<ul class="children">' . "\n"; |
|
67
|
|
|
break; |
|
68
|
|
|
} |
|
69
|
|
|
} |
|
70
|
|
|
|
|
71
|
|
|
/** |
|
72
|
|
|
* Ends the list of items after the elements are added. |
|
73
|
|
|
* |
|
74
|
|
|
* @since 2.7.0 |
|
75
|
|
|
* @access public |
|
76
|
|
|
* |
|
77
|
|
|
* @see Walker::end_lvl() |
|
78
|
|
|
* @global int $comment_depth |
|
79
|
|
|
* |
|
80
|
|
|
* @param string $output Passed by reference. Used to append additional content. |
|
81
|
|
|
* @param int $depth Optional. Depth of the current comment. Default 0. |
|
82
|
|
|
* @param array $args Optional. Will only append content if style argument value is 'ol' or 'ul'. |
|
83
|
|
|
* Default empty array. |
|
84
|
|
|
*/ |
|
85
|
|
View Code Duplication |
public function end_lvl( &$output, $depth = 0, $args = array() ) { |
|
86
|
|
|
$GLOBALS['comment_depth'] = $depth + 1; |
|
87
|
|
|
|
|
88
|
|
|
switch ( $args['style'] ) { |
|
89
|
|
|
case 'div': |
|
90
|
|
|
break; |
|
91
|
|
|
case 'ol': |
|
92
|
|
|
$output .= "</ol><!-- .children -->\n"; |
|
93
|
|
|
break; |
|
94
|
|
|
case 'ul': |
|
95
|
|
|
default: |
|
96
|
|
|
$output .= "</ul><!-- .children -->\n"; |
|
97
|
|
|
break; |
|
98
|
|
|
} |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
/** |
|
102
|
|
|
* Traverses elements to create list from elements. |
|
103
|
|
|
* |
|
104
|
|
|
* This function is designed to enhance Walker::display_element() to |
|
105
|
|
|
* display children of higher nesting levels than selected inline on |
|
106
|
|
|
* the highest depth level displayed. This prevents them being orphaned |
|
107
|
|
|
* at the end of the comment list. |
|
108
|
|
|
* |
|
109
|
|
|
* Example: max_depth = 2, with 5 levels of nested content. |
|
110
|
|
|
* 1 |
|
111
|
|
|
* 1.1 |
|
112
|
|
|
* 1.1.1 |
|
113
|
|
|
* 1.1.1.1 |
|
114
|
|
|
* 1.1.1.1.1 |
|
115
|
|
|
* 1.1.2 |
|
116
|
|
|
* 1.1.2.1 |
|
117
|
|
|
* 2 |
|
118
|
|
|
* 2.2 |
|
119
|
|
|
* |
|
120
|
|
|
* @since 2.7.0 |
|
121
|
|
|
* @access public |
|
122
|
|
|
* |
|
123
|
|
|
* @see Walker::display_element() |
|
124
|
|
|
* @see wp_list_comments() |
|
125
|
|
|
* |
|
126
|
|
|
* @param WP_Comment $element Comment data object. |
|
127
|
|
|
* @param array $children_elements List of elements to continue traversing. Passed by reference. |
|
128
|
|
|
* @param int $max_depth Max depth to traverse. |
|
129
|
|
|
* @param int $depth Depth of the current element. |
|
130
|
|
|
* @param array $args An array of arguments. |
|
131
|
|
|
* @param string $output Used to append additional content. Passed by reference. |
|
132
|
|
|
*/ |
|
133
|
|
|
public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) { |
|
134
|
|
|
if ( !$element ) |
|
135
|
|
|
return; |
|
136
|
|
|
|
|
137
|
|
|
$id_field = $this->db_fields['id']; |
|
138
|
|
|
$id = $element->$id_field; |
|
139
|
|
|
|
|
140
|
|
|
parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output ); |
|
141
|
|
|
|
|
142
|
|
|
/* |
|
143
|
|
|
* If at the max depth, and the current element still has children, loop over those |
|
144
|
|
|
* and display them at this level. This is to prevent them being orphaned to the end |
|
145
|
|
|
* of the list. |
|
146
|
|
|
*/ |
|
147
|
|
|
if ( $max_depth <= $depth + 1 && isset( $children_elements[$id]) ) { |
|
148
|
|
|
foreach ( $children_elements[ $id ] as $child ) |
|
149
|
|
|
$this->display_element( $child, $children_elements, $max_depth, $depth, $args, $output ); |
|
150
|
|
|
|
|
151
|
|
|
unset( $children_elements[ $id ] ); |
|
152
|
|
|
} |
|
153
|
|
|
|
|
154
|
|
|
} |
|
155
|
|
|
|
|
156
|
|
|
/** |
|
157
|
|
|
* Starts the element output. |
|
158
|
|
|
* |
|
159
|
|
|
* @since 2.7.0 |
|
160
|
|
|
* @access public |
|
161
|
|
|
* |
|
162
|
|
|
* @see Walker::start_el() |
|
163
|
|
|
* @see wp_list_comments() |
|
164
|
|
|
* @global int $comment_depth |
|
165
|
|
|
* @global WP_Comment $comment |
|
166
|
|
|
* |
|
167
|
|
|
* @param string $output Used to append additional content. Passed by reference. |
|
168
|
|
|
* @param WP_Comment $comment Comment data object. |
|
169
|
|
|
* @param int $depth Optional. Depth of the current comment in reference to parents. Default 0. |
|
170
|
|
|
* @param array $args Optional. An array of arguments. Default empty array. |
|
171
|
|
|
* @param int $id Optional. ID of the current comment. Default 0 (unused). |
|
172
|
|
|
*/ |
|
173
|
|
|
public function start_el( &$output, $comment, $depth = 0, $args = array(), $id = 0 ) { |
|
174
|
|
|
$depth++; |
|
175
|
|
|
$GLOBALS['comment_depth'] = $depth; |
|
176
|
|
|
$GLOBALS['comment'] = $comment; |
|
177
|
|
|
|
|
178
|
|
View Code Duplication |
if ( !empty( $args['callback'] ) ) { |
|
179
|
|
|
ob_start(); |
|
180
|
|
|
call_user_func( $args['callback'], $comment, $args, $depth ); |
|
181
|
|
|
$output .= ob_get_clean(); |
|
182
|
|
|
return; |
|
183
|
|
|
} |
|
184
|
|
|
|
|
185
|
|
|
if ( ( 'pingback' == $comment->comment_type || 'trackback' == $comment->comment_type ) && $args['short_ping'] ) { |
|
186
|
|
|
ob_start(); |
|
187
|
|
|
$this->ping( $comment, $depth, $args ); |
|
188
|
|
|
$output .= ob_get_clean(); |
|
189
|
|
|
} elseif ( 'html5' === $args['format'] ) { |
|
190
|
|
|
ob_start(); |
|
191
|
|
|
$this->html5_comment( $comment, $depth, $args ); |
|
192
|
|
|
$output .= ob_get_clean(); |
|
193
|
|
|
} else { |
|
194
|
|
|
ob_start(); |
|
195
|
|
|
$this->comment( $comment, $depth, $args ); |
|
196
|
|
|
$output .= ob_get_clean(); |
|
197
|
|
|
} |
|
198
|
|
|
} |
|
199
|
|
|
|
|
200
|
|
|
/** |
|
201
|
|
|
* Ends the element output, if needed. |
|
202
|
|
|
* |
|
203
|
|
|
* @since 2.7.0 |
|
204
|
|
|
* @access public |
|
205
|
|
|
* |
|
206
|
|
|
* @see Walker::end_el() |
|
207
|
|
|
* @see wp_list_comments() |
|
208
|
|
|
* |
|
209
|
|
|
* @param string $output Used to append additional content. Passed by reference. |
|
210
|
|
|
* @param WP_Comment $comment The current comment object. Default current comment. |
|
211
|
|
|
* @param int $depth Optional. Depth of the current comment. Default 0. |
|
212
|
|
|
* @param array $args Optional. An array of arguments. Default empty array. |
|
213
|
|
|
*/ |
|
214
|
|
|
public function end_el( &$output, $comment, $depth = 0, $args = array() ) { |
|
215
|
|
View Code Duplication |
if ( !empty( $args['end-callback'] ) ) { |
|
216
|
|
|
ob_start(); |
|
217
|
|
|
call_user_func( $args['end-callback'], $comment, $args, $depth ); |
|
218
|
|
|
$output .= ob_get_clean(); |
|
219
|
|
|
return; |
|
220
|
|
|
} |
|
221
|
|
|
if ( 'div' == $args['style'] ) |
|
222
|
|
|
$output .= "</div><!-- #comment-## -->\n"; |
|
223
|
|
|
else |
|
224
|
|
|
$output .= "</li><!-- #comment-## -->\n"; |
|
225
|
|
|
} |
|
226
|
|
|
|
|
227
|
|
|
/** |
|
228
|
|
|
* Outputs a pingback comment. |
|
229
|
|
|
* |
|
230
|
|
|
* @since 3.6.0 |
|
231
|
|
|
* @access protected |
|
232
|
|
|
* |
|
233
|
|
|
* @see wp_list_comments() |
|
234
|
|
|
* |
|
235
|
|
|
* @param WP_Comment $comment The comment object. |
|
236
|
|
|
* @param int $depth Depth of the current comment. |
|
237
|
|
|
* @param array $args An array of arguments. |
|
238
|
|
|
*/ |
|
239
|
|
|
protected function ping( $comment, $depth, $args ) { |
|
|
|
|
|
|
240
|
|
|
$tag = ( 'div' == $args['style'] ) ? 'div' : 'li'; |
|
241
|
|
|
?> |
|
242
|
|
|
<<?php echo $tag; ?> id="comment-<?php comment_ID(); ?>" <?php comment_class( '', $comment ); ?>> |
|
243
|
|
|
<div class="comment-body"> |
|
244
|
|
|
<?php _e( 'Pingback:' ); ?> <?php comment_author_link( $comment ); ?> <?php edit_comment_link( __( 'Edit' ), '<span class="edit-link">', '</span>' ); ?> |
|
245
|
|
|
</div> |
|
246
|
|
|
<?php |
|
247
|
|
|
} |
|
248
|
|
|
|
|
249
|
|
|
/** |
|
250
|
|
|
* Outputs a single comment. |
|
251
|
|
|
* |
|
252
|
|
|
* @since 3.6.0 |
|
253
|
|
|
* @access protected |
|
254
|
|
|
* |
|
255
|
|
|
* @see wp_list_comments() |
|
256
|
|
|
* |
|
257
|
|
|
* @param WP_Comment $comment Comment to display. |
|
258
|
|
|
* @param int $depth Depth of the current comment. |
|
259
|
|
|
* @param array $args An array of arguments. |
|
260
|
|
|
*/ |
|
261
|
|
|
protected function comment( $comment, $depth, $args ) { |
|
262
|
|
|
if ( 'div' == $args['style'] ) { |
|
263
|
|
|
$tag = 'div'; |
|
264
|
|
|
$add_below = 'comment'; |
|
265
|
|
|
} else { |
|
266
|
|
|
$tag = 'li'; |
|
267
|
|
|
$add_below = 'div-comment'; |
|
268
|
|
|
} |
|
269
|
|
|
?> |
|
270
|
|
|
<<?php echo $tag; ?> <?php comment_class( $this->has_children ? 'parent' : '', $comment ); ?> id="comment-<?php comment_ID(); ?>"> |
|
271
|
|
|
<?php if ( 'div' != $args['style'] ) : ?> |
|
272
|
|
|
<div id="div-comment-<?php comment_ID(); ?>" class="comment-body"> |
|
273
|
|
|
<?php endif; ?> |
|
274
|
|
|
<div class="comment-author vcard"> |
|
275
|
|
|
<?php if ( 0 != $args['avatar_size'] ) echo get_avatar( $comment, $args['avatar_size'] ); ?> |
|
276
|
|
|
<?php |
|
277
|
|
|
/* translators: %s: comment author link */ |
|
278
|
|
|
printf( __( '%s <span class="says">says:</span>' ), |
|
279
|
|
|
sprintf( '<cite class="fn">%s</cite>', get_comment_author_link( $comment ) ) |
|
280
|
|
|
); |
|
281
|
|
|
?> |
|
282
|
|
|
</div> |
|
283
|
|
|
<?php if ( '0' == $comment->comment_approved ) : ?> |
|
284
|
|
|
<em class="comment-awaiting-moderation"><?php _e( 'Your comment is awaiting moderation.' ) ?></em> |
|
285
|
|
|
<br /> |
|
286
|
|
|
<?php endif; ?> |
|
287
|
|
|
|
|
288
|
|
|
<div class="comment-meta commentmetadata"><a href="<?php echo esc_url( get_comment_link( $comment, $args ) ); ?>"> |
|
289
|
|
|
<?php |
|
290
|
|
|
/* translators: 1: comment date, 2: comment time */ |
|
291
|
|
|
printf( __( '%1$s at %2$s' ), get_comment_date( '', $comment ), get_comment_time() ); ?></a><?php edit_comment_link( __( '(Edit)' ), ' ', '' ); |
|
292
|
|
|
?> |
|
293
|
|
|
</div> |
|
294
|
|
|
|
|
295
|
|
|
<?php comment_text( $comment, array_merge( $args, array( 'add_below' => $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth'] ) ) ); ?> |
|
296
|
|
|
|
|
297
|
|
|
<?php |
|
298
|
|
|
comment_reply_link( array_merge( $args, array( |
|
299
|
|
|
'add_below' => $add_below, |
|
300
|
|
|
'depth' => $depth, |
|
301
|
|
|
'max_depth' => $args['max_depth'], |
|
302
|
|
|
'before' => '<div class="reply">', |
|
303
|
|
|
'after' => '</div>' |
|
304
|
|
|
) ) ); |
|
305
|
|
|
?> |
|
306
|
|
|
|
|
307
|
|
|
<?php if ( 'div' != $args['style'] ) : ?> |
|
308
|
|
|
</div> |
|
309
|
|
|
<?php endif; ?> |
|
310
|
|
|
<?php |
|
311
|
|
|
} |
|
312
|
|
|
|
|
313
|
|
|
/** |
|
314
|
|
|
* Outputs a comment in the HTML5 format. |
|
315
|
|
|
* |
|
316
|
|
|
* @since 3.6.0 |
|
317
|
|
|
* @access protected |
|
318
|
|
|
* |
|
319
|
|
|
* @see wp_list_comments() |
|
320
|
|
|
* |
|
321
|
|
|
* @param WP_Comment $comment Comment to display. |
|
322
|
|
|
* @param int $depth Depth of the current comment. |
|
323
|
|
|
* @param array $args An array of arguments. |
|
324
|
|
|
*/ |
|
325
|
|
|
protected function html5_comment( $comment, $depth, $args ) { |
|
326
|
|
|
$tag = ( 'div' === $args['style'] ) ? 'div' : 'li'; |
|
327
|
|
|
?> |
|
328
|
|
|
<<?php echo $tag; ?> id="comment-<?php comment_ID(); ?>" <?php comment_class( $this->has_children ? 'parent' : '', $comment ); ?>> |
|
329
|
|
|
<article id="div-comment-<?php comment_ID(); ?>" class="comment-body"> |
|
330
|
|
|
<footer class="comment-meta"> |
|
331
|
|
|
<div class="comment-author vcard"> |
|
332
|
|
|
<?php if ( 0 != $args['avatar_size'] ) echo get_avatar( $comment, $args['avatar_size'] ); ?> |
|
333
|
|
|
<?php |
|
334
|
|
|
/* translators: %s: comment author link */ |
|
335
|
|
|
printf( __( '%s <span class="says">says:</span>' ), |
|
336
|
|
|
sprintf( '<b class="fn">%s</b>', get_comment_author_link( $comment ) ) |
|
337
|
|
|
); |
|
338
|
|
|
?> |
|
339
|
|
|
</div><!-- .comment-author --> |
|
340
|
|
|
|
|
341
|
|
|
<div class="comment-metadata"> |
|
342
|
|
|
<a href="<?php echo esc_url( get_comment_link( $comment, $args ) ); ?>"> |
|
343
|
|
|
<time datetime="<?php comment_time( 'c' ); ?>"> |
|
344
|
|
|
<?php |
|
345
|
|
|
/* translators: 1: comment date, 2: comment time */ |
|
346
|
|
|
printf( __( '%1$s at %2$s' ), get_comment_date( '', $comment ), get_comment_time() ); |
|
347
|
|
|
?> |
|
348
|
|
|
</time> |
|
349
|
|
|
</a> |
|
350
|
|
|
<?php edit_comment_link( __( 'Edit' ), '<span class="edit-link">', '</span>' ); ?> |
|
351
|
|
|
</div><!-- .comment-metadata --> |
|
352
|
|
|
|
|
353
|
|
|
<?php if ( '0' == $comment->comment_approved ) : ?> |
|
354
|
|
|
<p class="comment-awaiting-moderation"><?php _e( 'Your comment is awaiting moderation.' ); ?></p> |
|
355
|
|
|
<?php endif; ?> |
|
356
|
|
|
</footer><!-- .comment-meta --> |
|
357
|
|
|
|
|
358
|
|
|
<div class="comment-content"> |
|
359
|
|
|
<?php comment_text(); ?> |
|
360
|
|
|
</div><!-- .comment-content --> |
|
361
|
|
|
|
|
362
|
|
|
<?php |
|
363
|
|
|
comment_reply_link( array_merge( $args, array( |
|
364
|
|
|
'add_below' => 'div-comment', |
|
365
|
|
|
'depth' => $depth, |
|
366
|
|
|
'max_depth' => $args['max_depth'], |
|
367
|
|
|
'before' => '<div class="reply">', |
|
368
|
|
|
'after' => '</div>' |
|
369
|
|
|
) ) ); |
|
370
|
|
|
?> |
|
371
|
|
|
</article><!-- .comment-body --> |
|
372
|
|
|
<?php |
|
373
|
|
|
} |
|
374
|
|
|
} |
|
375
|
|
|
|
This check looks from parameters that have been defined for a function or method, but which are not used in the method body.