| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Comment template functions 4 * 5 * These functions are meant to live inside of the WordPress loop. 6 * 7 * @package WordPress 8 * @subpackage Template 9 */ 10 11 /** 12 * Retrieves the author of the current comment. 13 * 14 * If the comment has an empty comment_author field, then 'Anonymous' person is 15 * assumed. 16 * 17 * @since 1.5.0 18 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 19 * 20 * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to retrieve the author. 21 * Default current comment. 22 * @return string The comment author 23 */ 24 function get_comment_author( $comment_id = 0 ) { 25 $comment = get_comment( $comment_id ); 26 27 if ( ! empty( $comment->comment_ID ) ) { 28 $comment_id = $comment->comment_ID; 29 } elseif ( is_scalar( $comment_id ) ) { 30 $comment_id = (string) $comment_id; 31 } else { 32 $comment_id = '0'; 33 } 34 35 if ( empty( $comment->comment_author ) ) { 36 $user = ! empty( $comment->user_id ) ? get_userdata( $comment->user_id ) : false; 37 if ( $user ) { 38 $comment_author = $user->display_name; 39 } else { 40 $comment_author = __( 'Anonymous' ); 41 } 42 } else { 43 $comment_author = $comment->comment_author; 44 } 45 46 /** 47 * Filters the returned comment author name. 48 * 49 * @since 1.5.0 50 * @since 4.1.0 The `$comment_id` and `$comment` parameters were added. 51 * 52 * @param string $comment_author The comment author's username. 53 * @param string $comment_id The comment ID as a numeric string. 54 * @param WP_Comment $comment The comment object. 55 */ 56 return apply_filters( 'get_comment_author', $comment_author, $comment_id, $comment ); 57 } 58 59 /** 60 * Displays the author of the current comment. 61 * 62 * @since 0.71 63 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 64 * 65 * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to print the author. 66 * Default current comment. 67 */ 68 function comment_author( $comment_id = 0 ) { 69 $comment = get_comment( $comment_id ); 70 71 $comment_author = get_comment_author( $comment ); 72 73 /** 74 * Filters the comment author's name for display. 75 * 76 * @since 1.2.0 77 * @since 4.1.0 The `$comment_id` parameter was added. 78 * 79 * @param string $comment_author The comment author's username. 80 * @param string $comment_id The comment ID as a numeric string. 81 */ 82 echo apply_filters( 'comment_author', $comment_author, $comment->comment_ID ); 83 } 84 85 /** 86 * Retrieves the email of the author of the current comment. 87 * 88 * @since 1.5.0 89 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 90 * 91 * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to get the author's email. 92 * Default current comment. 93 * @return string The current comment author's email 94 */ 95 function get_comment_author_email( $comment_id = 0 ) { 96 $comment = get_comment( $comment_id ); 97 98 /** 99 * Filters the comment author's returned email address. 100 * 101 * @since 1.5.0 102 * @since 4.1.0 The `$comment_id` and `$comment` parameters were added. 103 * 104 * @param string $comment_author_email The comment author's email address. 105 * @param string $comment_id The comment ID as a numeric string. 106 * @param WP_Comment $comment The comment object. 107 */ 108 return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment->comment_ID, $comment ); 109 } 110 111 /** 112 * Displays the email of the author of the current global $comment. 113 * 114 * Care should be taken to protect the email address and assure that email 115 * harvesters do not capture your commenter's email address. Most assume that 116 * their email address will not appear in raw form on the site. Doing so will 117 * enable anyone, including those that people don't want to get the email 118 * address and use it for their own means good and bad. 119 * 120 * @since 0.71 121 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 122 * 123 * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to print the author's email. 124 * Default current comment. 125 */ 126 function comment_author_email( $comment_id = 0 ) { 127 $comment = get_comment( $comment_id ); 128 129 $comment_author_email = get_comment_author_email( $comment ); 130 131 /** 132 * Filters the comment author's email for display. 133 * 134 * @since 1.2.0 135 * @since 4.1.0 The `$comment_id` parameter was added. 136 * 137 * @param string $comment_author_email The comment author's email address. 138 * @param string $comment_id The comment ID as a numeric string. 139 */ 140 echo apply_filters( 'author_email', $comment_author_email, $comment->comment_ID ); 141 } 142 143 /** 144 * Displays the HTML email link to the author of the current comment. 145 * 146 * Care should be taken to protect the email address and assure that email 147 * harvesters do not capture your commenter's email address. Most assume that 148 * their email address will not appear in raw form on the site. Doing so will 149 * enable anyone, including those that people don't want to get the email 150 * address and use it for their own means good and bad. 151 * 152 * @since 0.71 153 * @since 4.6.0 Added the `$comment` parameter. 154 * 155 * @param string $link_text Optional. Text to display instead of the comment author's email address. 156 * Default empty. 157 * @param string $before Optional. Text or HTML to display before the email link. Default empty. 158 * @param string $after Optional. Text or HTML to display after the email link. Default empty. 159 * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment. 160 */ 161 function comment_author_email_link( $link_text = '', $before = '', $after = '', $comment = null ) { 162 $link = get_comment_author_email_link( $link_text, $before, $after, $comment ); 163 if ( $link ) { 164 echo $link; 165 } 166 } 167 168 /** 169 * Returns the HTML email link to the author of the current comment. 170 * 171 * Care should be taken to protect the email address and assure that email 172 * harvesters do not capture your commenter's email address. Most assume that 173 * their email address will not appear in raw form on the site. Doing so will 174 * enable anyone, including those that people don't want to get the email 175 * address and use it for their own means good and bad. 176 * 177 * @since 2.7.0 178 * @since 4.6.0 Added the `$comment` parameter. 179 * 180 * @param string $link_text Optional. Text to display instead of the comment author's email address. 181 * Default empty. 182 * @param string $before Optional. Text or HTML to display before the email link. Default empty. 183 * @param string $after Optional. Text or HTML to display after the email link. Default empty. 184 * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment. 185 * @return string HTML markup for the comment author email link. By default, the email address is obfuscated 186 * via the {@see 'comment_email'} filter with antispambot(). 187 */ 188 function get_comment_author_email_link( $link_text = '', $before = '', $after = '', $comment = null ) { 189 $comment = get_comment( $comment ); 190 191 /** 192 * Filters the comment author's email for display. 193 * 194 * Care should be taken to protect the email address and assure that email 195 * harvesters do not capture your commenter's email address. 196 * 197 * @since 1.2.0 198 * @since 4.1.0 The `$comment` parameter was added. 199 * 200 * @param string $comment_author_email The comment author's email address. 201 * @param WP_Comment $comment The comment object. 202 */ 203 $comment_author_email = apply_filters( 'comment_email', $comment->comment_author_email, $comment ); 204 205 if ( ( ! empty( $comment_author_email ) ) && ( '@' !== $comment_author_email ) ) { 206 $display = ( '' !== $link_text ) ? $link_text : $comment_author_email; 207 208 $comment_author_email_link = $before . sprintf( 209 '<a href="%1$s">%2$s</a>', 210 esc_url( 'mailto:' . $comment_author_email ), 211 esc_html( $display ) 212 ) . $after; 213 214 return $comment_author_email_link; 215 } else { 216 return ''; 217 } 218 } 219 220 /** 221 * Retrieves the HTML link to the URL of the author of the current comment. 222 * 223 * Both get_comment_author_url() and get_comment_author() rely on get_comment(), 224 * which falls back to the global comment variable if the $comment_id argument is empty. 225 * 226 * @since 1.5.0 227 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 228 * 229 * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to get the author's link. 230 * Default current comment. 231 * @return string The comment author name or HTML link for author's URL. 232 */ 233 function get_comment_author_link( $comment_id = 0 ) { 234 $comment = get_comment( $comment_id ); 235 236 if ( ! empty( $comment->comment_ID ) ) { 237 $comment_id = $comment->comment_ID; 238 } elseif ( is_scalar( $comment_id ) ) { 239 $comment_id = (string) $comment_id; 240 } else { 241 $comment_id = '0'; 242 } 243 244 $comment_author_url = get_comment_author_url( $comment ); 245 $comment_author = get_comment_author( $comment ); 246 247 if ( empty( $comment_author_url ) || 'http://' === $comment_author_url ) { 248 $comment_author_link = $comment_author; 249 } else { 250 $rel_parts = array( 'ugc' ); 251 if ( ! wp_is_internal_link( $comment_author_url ) ) { 252 $rel_parts = array_merge( 253 $rel_parts, 254 array( 'external', 'nofollow' ) 255 ); 256 } 257 258 /** 259 * Filters the rel attributes of the comment author's link. 260 * 261 * @since 6.2.0 262 * 263 * @param string[] $rel_parts An array of strings representing the rel tags 264 * which will be joined into the anchor's rel attribute. 265 * @param WP_Comment $comment The comment object. 266 */ 267 $rel_parts = apply_filters( 'comment_author_link_rel', $rel_parts, $comment ); 268 269 $rel = implode( ' ', $rel_parts ); 270 $rel = esc_attr( $rel ); 271 // Empty space before 'rel' is necessary for later sprintf(). 272 $rel = ! empty( $rel ) ? sprintf( ' rel="%s"', $rel ) : ''; 273 274 $comment_author_link = sprintf( 275 '<a href="%1$s" class="url"%2$s>%3$s</a>', 276 $comment_author_url, 277 $rel, 278 $comment_author 279 ); 280 } 281 282 /** 283 * Filters the comment author's link for display. 284 * 285 * @since 1.5.0 286 * @since 4.1.0 The `$comment_author` and `$comment_id` parameters were added. 287 * 288 * @param string $comment_author_link The HTML-formatted comment author link. 289 * Empty for an invalid URL. 290 * @param string $comment_author The comment author's username. 291 * @param string $comment_id The comment ID as a numeric string. 292 */ 293 return apply_filters( 'get_comment_author_link', $comment_author_link, $comment_author, $comment_id ); 294 } 295 296 /** 297 * Displays the HTML link to the URL of the author of the current comment. 298 * 299 * @since 0.71 300 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 301 * 302 * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to print the author's link. 303 * Default current comment. 304 */ 305 function comment_author_link( $comment_id = 0 ) { 306 echo get_comment_author_link( $comment_id ); 307 } 308 309 /** 310 * Retrieves the IP address of the author of the current comment. 311 * 312 * @since 1.5.0 313 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 314 * 315 * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to get the author's IP address. 316 * Default current comment. 317 * @return string Comment author's IP address, or an empty string if it's not available. 318 */ 319 function get_comment_author_IP( $comment_id = 0 ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid 320 $comment = get_comment( $comment_id ); 321 322 /** 323 * Filters the comment author's returned IP address. 324 * 325 * @since 1.5.0 326 * @since 4.1.0 The `$comment_id` and `$comment` parameters were added. 327 * 328 * @param string $comment_author_ip The comment author's IP address, or an empty string if it's not available. 329 * @param string $comment_id The comment ID as a numeric string. 330 * @param WP_Comment $comment The comment object. 331 */ 332 return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment->comment_ID, $comment ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase 333 } 334 335 /** 336 * Displays the IP address of the author of the current comment. 337 * 338 * @since 0.71 339 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 340 * 341 * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to print the author's IP address. 342 * Default current comment. 343 */ 344 function comment_author_IP( $comment_id = 0 ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid 345 echo esc_html( get_comment_author_IP( $comment_id ) ); 346 } 347 348 /** 349 * Retrieves the URL of the author of the current comment, not linked. 350 * 351 * @since 1.5.0 352 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 353 * 354 * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to get the author's URL. 355 * Default current comment. 356 * @return string Comment author URL, if provided, an empty string otherwise. 357 */ 358 function get_comment_author_url( $comment_id = 0 ) { 359 $comment = get_comment( $comment_id ); 360 361 $comment_author_url = ''; 362 $comment_id = 0; 363 364 if ( ! empty( $comment ) ) { 365 $comment_author_url = ( 'http://' === $comment->comment_author_url ) ? '' : $comment->comment_author_url; 366 $comment_author_url = esc_url( $comment_author_url, array( 'http', 'https' ) ); 367 368 $comment_id = $comment->comment_ID; 369 } 370 371 /** 372 * Filters the comment author's URL. 373 * 374 * @since 1.5.0 375 * @since 4.1.0 The `$comment_id` and `$comment` parameters were added. 376 * 377 * @param string $comment_author_url The comment author's URL, or an empty string. 378 * @param string|int $comment_id The comment ID as a numeric string, or 0 if not found. 379 * @param WP_Comment|null $comment The comment object, or null if not found. 380 */ 381 return apply_filters( 'get_comment_author_url', $comment_author_url, $comment_id, $comment ); 382 } 383 384 /** 385 * Displays the URL of the author of the current comment, not linked. 386 * 387 * @since 0.71 388 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 389 * 390 * @param int|WP_Comment $comment_id Optional. WP_Comment or the ID of the comment for which to print the author's URL. 391 * Default current comment. 392 */ 393 function comment_author_url( $comment_id = 0 ) { 394 $comment = get_comment( $comment_id ); 395 396 $comment_author_url = get_comment_author_url( $comment ); 397 398 /** 399 * Filters the comment author's URL for display. 400 * 401 * @since 1.2.0 402 * @since 4.1.0 The `$comment_id` parameter was added. 403 * 404 * @param string $comment_author_url The comment author's URL. 405 * @param string $comment_id The comment ID as a numeric string. 406 */ 407 echo apply_filters( 'comment_url', $comment_author_url, $comment->comment_ID ); 408 } 409 410 /** 411 * Retrieves the HTML link of the URL of the author of the current comment. 412 * 413 * $link_text parameter is only used if the URL does not exist for the comment 414 * author. If the URL does exist then the URL will be used and the $link_text 415 * will be ignored. 416 * 417 * Encapsulate the HTML link between the $before and $after. So it will appear 418 * in the order of $before, link, and finally $after. 419 * 420 * @since 1.5.0 421 * @since 4.6.0 Added the `$comment` parameter. 422 * 423 * @param string $link_text Optional. The text to display instead of the comment 424 * author's email address. Default empty. 425 * @param string $before Optional. The text or HTML to display before the email link. 426 * Default empty. 427 * @param string $after Optional. The text or HTML to display after the email link. 428 * Default empty. 429 * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. 430 * Default is the current comment. 431 * @return string The HTML link between the $before and $after parameters. 432 */ 433 function get_comment_author_url_link( $link_text = '', $before = '', $after = '', $comment = 0 ) { 434 $comment_author_url = get_comment_author_url( $comment ); 435 436 $display = ( '' !== $link_text ) ? $link_text : $comment_author_url; 437 $display = str_replace( 'http://www.', '', $display ); 438 $display = str_replace( 'http://', '', $display ); 439 440 if ( str_ends_with( $display, '/' ) ) { 441 $display = substr( $display, 0, -1 ); 442 } 443 444 $comment_author_url_link = $before . sprintf( 445 '<a href="%1$s" rel="external">%2$s</a>', 446 $comment_author_url, 447 $display 448 ) . $after; 449 450 /** 451 * Filters the comment author's returned URL link. 452 * 453 * @since 1.5.0 454 * 455 * @param string $comment_author_url_link The HTML-formatted comment author URL link. 456 */ 457 return apply_filters( 'get_comment_author_url_link', $comment_author_url_link ); 458 } 459 460 /** 461 * Displays the HTML link of the URL of the author of the current comment. 462 * 463 * @since 0.71 464 * @since 4.6.0 Added the `$comment` parameter. 465 * 466 * @param string $link_text Optional. Text to display instead of the comment author's 467 * email address. Default empty. 468 * @param string $before Optional. Text or HTML to display before the email link. 469 * Default empty. 470 * @param string $after Optional. Text or HTML to display after the email link. 471 * Default empty. 472 * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. 473 * Default is the current comment. 474 */ 475 function comment_author_url_link( $link_text = '', $before = '', $after = '', $comment = 0 ) { 476 echo get_comment_author_url_link( $link_text, $before, $after, $comment ); 477 } 478 479 /** 480 * Generates semantic classes for each comment element. 481 * 482 * @since 2.7.0 483 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. 484 * 485 * @param string|string[] $css_class Optional. One or more classes to add to the class list. 486 * Default empty. 487 * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default current comment. 488 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. 489 * @param bool $display Optional. Whether to print or return the output. 490 * Default true. 491 * @return void|string Void if `$display` argument is true, comment classes if `$display` is false. 492 */ 493 function comment_class( $css_class = '', $comment = null, $post = null, $display = true ) { 494 // Separates classes with a single space, collates classes for comment DIV. 495 $css_class = 'class="' . implode( ' ', get_comment_class( $css_class, $comment, $post ) ) . '"'; 496 497 if ( $display ) { 498 echo $css_class; 499 } else { 500 return $css_class; 501 } 502 } 503 504 /** 505 * Returns the classes for the comment div as an array. 506 * 507 * @since 2.7.0 508 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 509 * 510 * @global int $comment_alt 511 * @global int $comment_depth 512 * @global int $comment_thread_alt 513 * 514 * @param string|string[] $css_class Optional. One or more classes to add to the class list. 515 * Default empty. 516 * @param int|WP_Comment $comment_id Optional. Comment ID or WP_Comment object. Default current comment. 517 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. 518 * @return string[] An array of classes. 519 */ 520 function get_comment_class( $css_class = '', $comment_id = null, $post = null ) { 521 global $comment_alt, $comment_depth, $comment_thread_alt; 522 523 $classes = array(); 524 525 $comment = get_comment( $comment_id ); 526 if ( ! $comment ) { 527 return $classes; 528 } 529 530 // Get the comment type (comment, trackback). 531 $classes[] = ( empty( $comment->comment_type ) ) ? 'comment' : $comment->comment_type; 532 533 // Add classes for comment authors that are registered users. 534 $user = $comment->user_id ? get_userdata( $comment->user_id ) : false; 535 if ( $user ) { 536 $classes[] = 'byuser'; 537 $classes[] = 'comment-author-' . sanitize_html_class( $user->user_nicename, $comment->user_id ); 538 // For comment authors who are the author of the post. 539 $_post = get_post( $post ); 540 if ( $_post ) { 541 if ( $comment->user_id === $_post->post_author ) { 542 $classes[] = 'bypostauthor'; 543 } 544 } 545 } 546 547 if ( empty( $comment_alt ) ) { 548 $comment_alt = 0; 549 } 550 if ( empty( $comment_depth ) ) { 551 $comment_depth = 1; 552 } 553 if ( empty( $comment_thread_alt ) ) { 554 $comment_thread_alt = 0; 555 } 556 557 if ( $comment_alt % 2 ) { 558 $classes[] = 'odd'; 559 $classes[] = 'alt'; 560 } else { 561 $classes[] = 'even'; 562 } 563 564 ++$comment_alt; 565 566 // Alt for top-level comments. 567 if ( 1 == $comment_depth ) { 568 if ( $comment_thread_alt % 2 ) { 569 $classes[] = 'thread-odd'; 570 $classes[] = 'thread-alt'; 571 } else { 572 $classes[] = 'thread-even'; 573 } 574 ++$comment_thread_alt; 575 } 576 577 $classes[] = "depth-$comment_depth"; 578 579 if ( ! empty( $css_class ) ) { 580 if ( ! is_array( $css_class ) ) { 581 $css_class = preg_split( '#\s+#', $css_class ); 582 } 583 $classes = array_merge( $classes, $css_class ); 584 } 585 586 $classes = array_map( 'esc_attr', $classes ); 587 588 /** 589 * Filters the returned CSS classes for the current comment. 590 * 591 * @since 2.7.0 592 * 593 * @param string[] $classes An array of comment classes. 594 * @param string[] $css_class An array of additional classes added to the list. 595 * @param string $comment_id The comment ID as a numeric string. 596 * @param WP_Comment $comment The comment object. 597 * @param int|WP_Post $post The post ID or WP_Post object. 598 */ 599 return apply_filters( 'comment_class', $classes, $css_class, $comment->comment_ID, $comment, $post ); 600 } 601 602 /** 603 * Retrieves the comment date of the current comment. 604 * 605 * @since 1.5.0 606 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 607 * 608 * @param string $format Optional. PHP date format. Defaults to the 'date_format' option. 609 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to get the date. 610 * Default current comment. 611 * @return string The comment's date. 612 */ 613 function get_comment_date( $format = '', $comment_id = 0 ) { 614 $comment = get_comment( $comment_id ); 615 616 $_format = ! empty( $format ) ? $format : get_option( 'date_format' ); 617 618 $comment_date = mysql2date( $_format, $comment->comment_date ); 619 620 /** 621 * Filters the returned comment date. 622 * 623 * @since 1.5.0 624 * 625 * @param string|int $comment_date Formatted date string or Unix timestamp. 626 * @param string $format PHP date format. 627 * @param WP_Comment $comment The comment object. 628 */ 629 return apply_filters( 'get_comment_date', $comment_date, $format, $comment ); 630 } 631 632 /** 633 * Displays the comment date of the current comment. 634 * 635 * @since 0.71 636 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 637 * 638 * @param string $format Optional. PHP date format. Defaults to the 'date_format' option. 639 * @param int|WP_Comment $comment_id WP_Comment or ID of the comment for which to print the date. 640 * Default current comment. 641 */ 642 function comment_date( $format = '', $comment_id = 0 ) { 643 echo get_comment_date( $format, $comment_id ); 644 } 645 646 /** 647 * Retrieves the excerpt of the given comment. 648 * 649 * Returns a maximum of 20 words with an ellipsis appended if necessary. 650 * 651 * @since 1.5.0 652 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 653 * 654 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to get the excerpt. 655 * Default current comment. 656 * @return string The possibly truncated comment excerpt. 657 */ 658 function get_comment_excerpt( $comment_id = 0 ) { 659 $comment = get_comment( $comment_id ); 660 661 if ( ! post_password_required( $comment->comment_post_ID ) ) { 662 $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) ); 663 } else { 664 $comment_text = __( 'Password protected' ); 665 } 666 667 /* translators: Maximum number of words used in a comment excerpt. */ 668 $comment_excerpt_length = (int) _x( '20', 'comment_excerpt_length' ); 669 670 /** 671 * Filters the maximum number of words used in the comment excerpt. 672 * 673 * @since 4.4.0 674 * 675 * @param int $comment_excerpt_length The amount of words you want to display in the comment excerpt. 676 */ 677 $comment_excerpt_length = apply_filters( 'comment_excerpt_length', $comment_excerpt_length ); 678 679 $comment_excerpt = wp_trim_words( $comment_text, $comment_excerpt_length, '…' ); 680 681 /** 682 * Filters the retrieved comment excerpt. 683 * 684 * @since 1.5.0 685 * @since 4.1.0 The `$comment_id` and `$comment` parameters were added. 686 * 687 * @param string $comment_excerpt The comment excerpt text. 688 * @param string $comment_id The comment ID as a numeric string. 689 * @param WP_Comment $comment The comment object. 690 */ 691 return apply_filters( 'get_comment_excerpt', $comment_excerpt, $comment->comment_ID, $comment ); 692 } 693 694 /** 695 * Displays the excerpt of the current comment. 696 * 697 * @since 1.2.0 698 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 699 * 700 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to print the excerpt. 701 * Default current comment. 702 */ 703 function comment_excerpt( $comment_id = 0 ) { 704 $comment = get_comment( $comment_id ); 705 706 $comment_excerpt = get_comment_excerpt( $comment ); 707 708 /** 709 * Filters the comment excerpt for display. 710 * 711 * @since 1.2.0 712 * @since 4.1.0 The `$comment_id` parameter was added. 713 * 714 * @param string $comment_excerpt The comment excerpt text. 715 * @param string $comment_id The comment ID as a numeric string. 716 */ 717 echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment->comment_ID ); 718 } 719 720 /** 721 * Retrieves the comment ID of the current comment. 722 * 723 * @since 1.5.0 724 * 725 * @return string The comment ID as a numeric string. 726 */ 727 function get_comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid 728 $comment = get_comment(); 729 730 $comment_id = ! empty( $comment->comment_ID ) ? $comment->comment_ID : '0'; 731 732 /** 733 * Filters the returned comment ID. 734 * 735 * @since 1.5.0 736 * @since 4.1.0 The `$comment` parameter was added. 737 * 738 * @param string $comment_id The current comment ID as a numeric string. 739 * @param WP_Comment $comment The comment object. 740 */ 741 return apply_filters( 'get_comment_ID', $comment_id, $comment ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase 742 } 743 744 /** 745 * Displays the comment ID of the current comment. 746 * 747 * @since 0.71 748 */ 749 function comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid 750 echo get_comment_ID(); 751 } 752 753 /** 754 * Retrieves the link to a given comment. 755 * 756 * @since 1.5.0 757 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. Added `$cpage` argument. 758 * 759 * @see get_page_of_comment() 760 * 761 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 762 * @global bool $in_comment_loop 763 * 764 * @param WP_Comment|int|null $comment Optional. Comment to retrieve. Default current comment. 765 * @param array $args { 766 * An array of optional arguments to override the defaults. 767 * 768 * @type string $type Passed to get_page_of_comment(). 769 * @type int $page Current page of comments, for calculating comment pagination. 770 * @type int $per_page Per-page value for comment pagination. 771 * @type int $max_depth Passed to get_page_of_comment(). 772 * @type int|string $cpage Value to use for the comment's "comment-page" or "cpage" value. 773 * If provided, this value overrides any value calculated from `$page` 774 * and `$per_page`. 775 * } 776 * @return string The permalink to the given comment. 777 */ 778 function get_comment_link( $comment = null, $args = array() ) { 779 global $wp_rewrite, $in_comment_loop; 780 781 $comment = get_comment( $comment ); 782 783 // Back-compat. 784 if ( ! is_array( $args ) ) { 785 $args = array( 'page' => $args ); 786 } 787 788 $defaults = array( 789 'type' => 'all', 790 'page' => '', 791 'per_page' => '', 792 'max_depth' => '', 793 'cpage' => null, 794 ); 795 796 $args = wp_parse_args( $args, $defaults ); 797 798 $comment_link = get_permalink( $comment->comment_post_ID ); 799 800 // The 'cpage' param takes precedence. 801 if ( ! is_null( $args['cpage'] ) ) { 802 $cpage = $args['cpage']; 803 804 // No 'cpage' is provided, so we calculate one. 805 } else { 806 if ( '' === $args['per_page'] && get_option( 'page_comments' ) ) { 807 $args['per_page'] = get_option( 'comments_per_page' ); 808 } 809 810 if ( empty( $args['per_page'] ) ) { 811 $args['per_page'] = 0; 812 $args['page'] = 0; 813 } 814 815 $cpage = $args['page']; 816 817 if ( '' == $cpage ) { 818 if ( ! empty( $in_comment_loop ) ) { 819 $cpage = get_query_var( 'cpage' ); 820 } else { 821 // Requires a database hit, so we only do it when we can't figure out from context. 822 $cpage = get_page_of_comment( $comment->comment_ID, $args ); 823 } 824 } 825 826 /* 827 * If the default page displays the oldest comments, the permalinks for comments on the default page 828 * do not need a 'cpage' query var. 829 */ 830 if ( 'oldest' === get_option( 'default_comments_page' ) && 1 === $cpage ) { 831 $cpage = ''; 832 } 833 } 834 835 if ( $cpage && get_option( 'page_comments' ) ) { 836 if ( $wp_rewrite->using_permalinks() ) { 837 if ( $cpage ) { 838 $comment_link = trailingslashit( $comment_link ) . $wp_rewrite->comments_pagination_base . '-' . $cpage; 839 } 840 841 $comment_link = user_trailingslashit( $comment_link, 'comment' ); 842 } elseif ( $cpage ) { 843 $comment_link = add_query_arg( 'cpage', $cpage, $comment_link ); 844 } 845 } 846 847 if ( $wp_rewrite->using_permalinks() ) { 848 $comment_link = user_trailingslashit( $comment_link, 'comment' ); 849 } 850 851 $comment_link = $comment_link . '#comment-' . $comment->comment_ID; 852 853 /** 854 * Filters the returned single comment permalink. 855 * 856 * @since 2.8.0 857 * @since 4.4.0 Added the `$cpage` parameter. 858 * 859 * @see get_page_of_comment() 860 * 861 * @param string $comment_link The comment permalink with '#comment-$id' appended. 862 * @param WP_Comment $comment The current comment object. 863 * @param array $args An array of arguments to override the defaults. 864 * @param int $cpage The calculated 'cpage' value. 865 */ 866 return apply_filters( 'get_comment_link', $comment_link, $comment, $args, $cpage ); 867 } 868 869 /** 870 * Retrieves the link to the current post comments. 871 * 872 * @since 1.5.0 873 * 874 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 875 * @return string The link to the comments. 876 */ 877 function get_comments_link( $post = 0 ) { 878 $hash = get_comments_number( $post ) ? '#comments' : '#respond'; 879 $comments_link = get_permalink( $post ) . $hash; 880 881 /** 882 * Filters the returned post comments permalink. 883 * 884 * @since 3.6.0 885 * 886 * @param string $comments_link Post comments permalink with '#comments' appended. 887 * @param int|WP_Post $post Post ID or WP_Post object. 888 */ 889 return apply_filters( 'get_comments_link', $comments_link, $post ); 890 } 891 892 /** 893 * Displays the link to the current post comments. 894 * 895 * @since 0.71 896 * 897 * @param string $deprecated Not Used. 898 * @param string $deprecated_2 Not Used. 899 */ 900 function comments_link( $deprecated = '', $deprecated_2 = '' ) { 901 if ( ! empty( $deprecated ) ) { 902 _deprecated_argument( __FUNCTION__, '0.72' ); 903 } 904 if ( ! empty( $deprecated_2 ) ) { 905 _deprecated_argument( __FUNCTION__, '1.3.0' ); 906 } 907 echo esc_url( get_comments_link() ); 908 } 909 910 /** 911 * Retrieves the amount of comments a post has. 912 * 913 * @since 1.5.0 914 * 915 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is the global `$post`. 916 * @return string|int If the post exists, a numeric string representing the number of comments 917 * the post has, otherwise 0. 918 */ 919 function get_comments_number( $post = 0 ) { 920 $post = get_post( $post ); 921 922 $comments_number = $post ? $post->comment_count : 0; 923 $post_id = $post ? $post->ID : 0; 924 925 /** 926 * Filters the returned comment count for a post. 927 * 928 * @since 1.5.0 929 * 930 * @param string|int $comments_number A string representing the number of comments a post has, otherwise 0. 931 * @param int $post_id Post ID. 932 */ 933 return apply_filters( 'get_comments_number', $comments_number, $post_id ); 934 } 935 936 /** 937 * Displays the language string for the number of comments the current post has. 938 * 939 * @since 0.71 940 * @since 5.4.0 The `$deprecated` parameter was changed to `$post`. 941 * 942 * @param string|false $zero Optional. Text for no comments. Default false. 943 * @param string|false $one Optional. Text for one comment. Default false. 944 * @param string|false $more Optional. Text for more than one comment. Default false. 945 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is the global `$post`. 946 */ 947 function comments_number( $zero = false, $one = false, $more = false, $post = 0 ) { 948 echo get_comments_number_text( $zero, $one, $more, $post ); 949 } 950 951 /** 952 * Displays the language string for the number of comments the current post has. 953 * 954 * @since 4.0.0 955 * @since 5.4.0 Added the `$post` parameter to allow using the function outside of the loop. 956 * 957 * @param string $zero Optional. Text for no comments. Default false. 958 * @param string $one Optional. Text for one comment. Default false. 959 * @param string $more Optional. Text for more than one comment. Default false. 960 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is the global `$post`. 961 * @return string Language string for the number of comments a post has. 962 */ 963 function get_comments_number_text( $zero = false, $one = false, $more = false, $post = 0 ) { 964 $comments_number = get_comments_number( $post ); 965 966 if ( $comments_number > 1 ) { 967 if ( false === $more ) { 968 $comments_number_text = sprintf( 969 /* translators: %s: Number of comments. */ 970 _n( '%s Comment', '%s Comments', $comments_number ), 971 number_format_i18n( $comments_number ) 972 ); 973 } else { 974 // % Comments 975 /* 976 * translators: If comment number in your language requires declension, 977 * translate this to 'on'. Do not translate into your own language. 978 */ 979 if ( 'on' === _x( 'off', 'Comment number declension: on or off' ) ) { 980 $text = preg_replace( '#<span class="screen-reader-text">.+?</span>#', '', $more ); 981 $text = preg_replace( '/&.+?;/', '', $text ); // Remove HTML entities. 982 $text = trim( strip_tags( $text ), '% ' ); 983 984 // Replace '% Comments' with a proper plural form. 985 if ( $text && ! preg_match( '/[0-9]+/', $text ) && str_contains( $more, '%' ) ) { 986 /* translators: %s: Number of comments. */ 987 $new_text = _n( '%s Comment', '%s Comments', $comments_number ); 988 $new_text = trim( sprintf( $new_text, '' ) ); 989 990 $more = str_replace( $text, $new_text, $more ); 991 if ( ! str_contains( $more, '%' ) ) { 992 $more = '% ' . $more; 993 } 994 } 995 } 996 997 $comments_number_text = str_replace( '%', number_format_i18n( $comments_number ), $more ); 998 } 999 } elseif ( 0 == $comments_number ) { 1000 $comments_number_text = ( false === $zero ) ? __( 'No Comments' ) : $zero; 1001 } else { // Must be one. 1002 $comments_number_text = ( false === $one ) ? __( '1 Comment' ) : $one; 1003 } 1004 1005 /** 1006 * Filters the comments count for display. 1007 * 1008 * @since 1.5.0 1009 * 1010 * @see _n() 1011 * 1012 * @param string $comments_number_text A translatable string formatted based on whether the count 1013 * is equal to 0, 1, or 1+. 1014 * @param int $comments_number The number of post comments. 1015 */ 1016 return apply_filters( 'comments_number', $comments_number_text, $comments_number ); 1017 } 1018 1019 /** 1020 * Retrieves the text of the current comment. 1021 * 1022 * @since 1.5.0 1023 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 1024 * @since 5.4.0 Added 'In reply to %s.' prefix to child comments in comments feed. 1025 * 1026 * @see Walker_Comment::comment() 1027 * 1028 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to get the text. 1029 * Default current comment. 1030 * @param array $args Optional. An array of arguments. Default empty array. 1031 * @return string The comment content. 1032 */ 1033 function get_comment_text( $comment_id = 0, $args = array() ) { 1034 $comment = get_comment( $comment_id ); 1035 1036 $comment_text = $comment->comment_content; 1037 1038 if ( is_comment_feed() && $comment->comment_parent ) { 1039 $parent = get_comment( $comment->comment_parent ); 1040 if ( $parent ) { 1041 $parent_link = esc_url( get_comment_link( $parent ) ); 1042 $name = get_comment_author( $parent ); 1043 1044 $comment_text = sprintf( 1045 /* translators: %s: Comment link. */ 1046 ent2ncr( __( 'In reply to %s.' ) ), 1047 '<a href="' . $parent_link . '">' . $name . '</a>' 1048 ) . "\n\n" . $comment_text; 1049 } 1050 } 1051 1052 /** 1053 * Filters the text of a comment. 1054 * 1055 * @since 1.5.0 1056 * 1057 * @see Walker_Comment::comment() 1058 * 1059 * @param string $comment_text Text of the comment. 1060 * @param WP_Comment $comment The comment object. 1061 * @param array $args An array of arguments. 1062 */ 1063 return apply_filters( 'get_comment_text', $comment_text, $comment, $args ); 1064 } 1065 1066 /** 1067 * Displays the text of the current comment. 1068 * 1069 * @since 0.71 1070 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 1071 * 1072 * @see Walker_Comment::comment() 1073 * 1074 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to print the text. 1075 * Default current comment. 1076 * @param array $args Optional. An array of arguments. Default empty array. 1077 */ 1078 function comment_text( $comment_id = 0, $args = array() ) { 1079 $comment = get_comment( $comment_id ); 1080 1081 $comment_text = get_comment_text( $comment, $args ); 1082 1083 /** 1084 * Filters the text of a comment to be displayed. 1085 * 1086 * @since 1.2.0 1087 * 1088 * @see Walker_Comment::comment() 1089 * 1090 * @param string $comment_text Text of the comment. 1091 * @param WP_Comment|null $comment The comment object. Null if not found. 1092 * @param array $args An array of arguments. 1093 */ 1094 echo apply_filters( 'comment_text', $comment_text, $comment, $args ); 1095 } 1096 1097 /** 1098 * Retrieves the comment time of the current comment. 1099 * 1100 * @since 1.5.0 1101 * @since 6.2.0 Added the `$comment_id` parameter. 1102 * 1103 * @param string $format Optional. PHP date format. Defaults to the 'time_format' option. 1104 * @param bool $gmt Optional. Whether to use the GMT date. Default false. 1105 * @param bool $translate Optional. Whether to translate the time (for use in feeds). 1106 * Default true. 1107 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to get the time. 1108 * Default current comment. 1109 * @return string The formatted time. 1110 */ 1111 function get_comment_time( $format = '', $gmt = false, $translate = true, $comment_id = 0 ) { 1112 $comment = get_comment( $comment_id ); 1113 1114 if ( null === $comment ) { 1115 return ''; 1116 } 1117 1118 $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date; 1119 1120 $_format = ! empty( $format ) ? $format : get_option( 'time_format' ); 1121 1122 $comment_time = mysql2date( $_format, $comment_date, $translate ); 1123 1124 /** 1125 * Filters the returned comment time. 1126 * 1127 * @since 1.5.0 1128 * 1129 * @param string|int $comment_time The comment time, formatted as a date string or Unix timestamp. 1130 * @param string $format PHP date format. 1131 * @param bool $gmt Whether the GMT date is in use. 1132 * @param bool $translate Whether the time is translated. 1133 * @param WP_Comment $comment The comment object. 1134 */ 1135 return apply_filters( 'get_comment_time', $comment_time, $format, $gmt, $translate, $comment ); 1136 } 1137 1138 /** 1139 * Displays the comment time of the current comment. 1140 * 1141 * @since 0.71 1142 * @since 6.2.0 Added the `$comment_id` parameter. 1143 * 1144 * @param string $format Optional. PHP time format. Defaults to the 'time_format' option. 1145 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to print the time. 1146 * Default current comment. 1147 */ 1148 function comment_time( $format = '', $comment_id = 0 ) { 1149 echo get_comment_time( $format, false, true, $comment_id ); 1150 } 1151 1152 /** 1153 * Retrieves the comment type of the current comment. 1154 * 1155 * @since 1.5.0 1156 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 1157 * 1158 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to get the type. 1159 * Default current comment. 1160 * @return string The comment type. 1161 */ 1162 function get_comment_type( $comment_id = 0 ) { 1163 $comment = get_comment( $comment_id ); 1164 1165 if ( '' === $comment->comment_type ) { 1166 $comment->comment_type = 'comment'; 1167 } 1168 1169 /** 1170 * Filters the returned comment type. 1171 * 1172 * @since 1.5.0 1173 * @since 4.1.0 The `$comment_id` and `$comment` parameters were added. 1174 * 1175 * @param string $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'. 1176 * @param string $comment_id The comment ID as a numeric string. 1177 * @param WP_Comment $comment The comment object. 1178 */ 1179 return apply_filters( 'get_comment_type', $comment->comment_type, $comment->comment_ID, $comment ); 1180 } 1181 1182 /** 1183 * Displays the comment type of the current comment. 1184 * 1185 * @since 0.71 1186 * 1187 * @param string|false $commenttxt Optional. String to display for comment type. Default false. 1188 * @param string|false $trackbacktxt Optional. String to display for trackback type. Default false. 1189 * @param string|false $pingbacktxt Optional. String to display for pingback type. Default false. 1190 */ 1191 function comment_type( $commenttxt = false, $trackbacktxt = false, $pingbacktxt = false ) { 1192 if ( false === $commenttxt ) { 1193 $commenttxt = _x( 'Comment', 'noun' ); 1194 } 1195 if ( false === $trackbacktxt ) { 1196 $trackbacktxt = __( 'Trackback' ); 1197 } 1198 if ( false === $pingbacktxt ) { 1199 $pingbacktxt = __( 'Pingback' ); 1200 } 1201 $type = get_comment_type(); 1202 switch ( $type ) { 1203 case 'trackback': 1204 echo $trackbacktxt; 1205 break; 1206 case 'pingback': 1207 echo $pingbacktxt; 1208 break; 1209 default: 1210 echo $commenttxt; 1211 } 1212 } 1213 1214 /** 1215 * Retrieves the current post's trackback URL. 1216 * 1217 * There is a check to see if permalink's have been enabled and if so, will 1218 * retrieve the pretty path. If permalinks weren't enabled, the ID of the 1219 * current post is used and appended to the correct page to go to. 1220 * 1221 * @since 1.5.0 1222 * 1223 * @return string The trackback URL after being filtered. 1224 */ 1225 function get_trackback_url() { 1226 if ( get_option( 'permalink_structure' ) ) { 1227 $trackback_url = trailingslashit( get_permalink() ) . user_trailingslashit( 'trackback', 'single_trackback' ); 1228 } else { 1229 $trackback_url = get_option( 'siteurl' ) . '/wp-trackback.php?p=' . get_the_ID(); 1230 } 1231 1232 /** 1233 * Filters the returned trackback URL. 1234 * 1235 * @since 2.2.0 1236 * 1237 * @param string $trackback_url The trackback URL. 1238 */ 1239 return apply_filters( 'trackback_url', $trackback_url ); 1240 } 1241 1242 /** 1243 * Displays the current post's trackback URL. 1244 * 1245 * @since 0.71 1246 * 1247 * @param bool $deprecated_echo Not used. 1248 * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() 1249 * for the result instead. 1250 */ 1251 function trackback_url( $deprecated_echo = true ) { 1252 if ( true !== $deprecated_echo ) { 1253 _deprecated_argument( 1254 __FUNCTION__, 1255 '2.5.0', 1256 sprintf( 1257 /* translators: %s: get_trackback_url() */ 1258 __( 'Use %s instead if you do not want the value echoed.' ), 1259 '<code>get_trackback_url()</code>' 1260 ) 1261 ); 1262 } 1263 1264 if ( $deprecated_echo ) { 1265 echo get_trackback_url(); 1266 } else { 1267 return get_trackback_url(); 1268 } 1269 } 1270 1271 /** 1272 * Generates and displays the RDF for the trackback information of current post. 1273 * 1274 * Deprecated in 3.0.0, and restored in 3.0.1. 1275 * 1276 * @since 0.71 1277 * 1278 * @param int|string $deprecated Not used (Was $timezone = 0). 1279 */ 1280 function trackback_rdf( $deprecated = '' ) { 1281 if ( ! empty( $deprecated ) ) { 1282 _deprecated_argument( __FUNCTION__, '2.5.0' ); 1283 } 1284 1285 if ( isset( $_SERVER['HTTP_USER_AGENT'] ) && false !== stripos( $_SERVER['HTTP_USER_AGENT'], 'W3C_Validator' ) ) { 1286 return; 1287 } 1288 1289 echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 1290 xmlns:dc="http://purl.org/dc/elements/1.1/" 1291 xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/"> 1292 <rdf:Description rdf:about="'; 1293 the_permalink(); 1294 echo '"' . "\n"; 1295 echo ' dc:identifier="'; 1296 the_permalink(); 1297 echo '"' . "\n"; 1298 echo ' dc:title="' . str_replace( '--', '--', wptexturize( strip_tags( get_the_title() ) ) ) . '"' . "\n"; 1299 echo ' trackback:ping="' . get_trackback_url() . '"' . " />\n"; 1300 echo '</rdf:RDF>'; 1301 } 1302 1303 /** 1304 * Determines whether the current post is open for comments. 1305 * 1306 * For more information on this and similar theme functions, check out 1307 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1308 * Conditional Tags} article in the Theme Developer Handbook. 1309 * 1310 * @since 1.5.0 1311 * 1312 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. 1313 * @return bool True if the comments are open. 1314 */ 1315 function comments_open( $post = null ) { 1316 $_post = get_post( $post ); 1317 1318 $post_id = $_post ? $_post->ID : 0; 1319 $comments_open = ( $_post && ( 'open' === $_post->comment_status ) ); 1320 1321 /** 1322 * Filters whether the current post is open for comments. 1323 * 1324 * @since 2.5.0 1325 * 1326 * @param bool $comments_open Whether the current post is open for comments. 1327 * @param int $post_id The post ID. 1328 */ 1329 return apply_filters( 'comments_open', $comments_open, $post_id ); 1330 } 1331 1332 /** 1333 * Determines whether the current post is open for pings. 1334 * 1335 * For more information on this and similar theme functions, check out 1336 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1337 * Conditional Tags} article in the Theme Developer Handbook. 1338 * 1339 * @since 1.5.0 1340 * 1341 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. 1342 * @return bool True if pings are accepted 1343 */ 1344 function pings_open( $post = null ) { 1345 $_post = get_post( $post ); 1346 1347 $post_id = $_post ? $_post->ID : 0; 1348 $pings_open = ( $_post && ( 'open' === $_post->ping_status ) ); 1349 1350 /** 1351 * Filters whether the current post is open for pings. 1352 * 1353 * @since 2.5.0 1354 * 1355 * @param bool $pings_open Whether the current post is open for pings. 1356 * @param int $post_id The post ID. 1357 */ 1358 return apply_filters( 'pings_open', $pings_open, $post_id ); 1359 } 1360 1361 /** 1362 * Displays form token for unfiltered comments. 1363 * 1364 * Will only display nonce token if the current user has permissions for 1365 * unfiltered html. Won't display the token for other users. 1366 * 1367 * The function was backported to 2.0.10 and was added to versions 2.1.3 and 1368 * above. Does not exist in versions prior to 2.0.10 in the 2.0 branch and in 1369 * the 2.1 branch, prior to 2.1.3. Technically added in 2.2.0. 1370 * 1371 * Backported to 2.0.10. 1372 * 1373 * @since 2.1.3 1374 */ 1375 function wp_comment_form_unfiltered_html_nonce() { 1376 $post = get_post(); 1377 $post_id = $post ? $post->ID : 0; 1378 1379 if ( current_user_can( 'unfiltered_html' ) ) { 1380 wp_nonce_field( 'unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment_disabled', false ); 1381 wp_print_inline_script_tag( "(function(){if(window===window.parent){document.getElementById('_wp_unfiltered_html_comment_disabled').name='_wp_unfiltered_html_comment';}})();" ); 1382 } 1383 } 1384 1385 /** 1386 * Loads the comment template specified in $file. 1387 * 1388 * Will not display the comments template if not on single post or page, or if 1389 * the post does not have comments. 1390 * 1391 * Uses the WordPress database object to query for the comments. The comments 1392 * are passed through the {@see 'comments_array'} filter hook with the list of comments 1393 * and the post ID respectively. 1394 * 1395 * The `$file` path is passed through a filter hook called {@see 'comments_template'}, 1396 * which includes the template directory and $file combined. Tries the $filtered path 1397 * first and if it fails it will require the default comment template from the 1398 * default theme. If either does not exist, then the WordPress process will be 1399 * halted. It is advised for that reason, that the default theme is not deleted. 1400 * 1401 * Will not try to get the comments if the post has none. 1402 * 1403 * @since 1.5.0 1404 * 1405 * @global WP_Query $wp_query WordPress Query object. 1406 * @global WP_Post $post Global post object. 1407 * @global wpdb $wpdb WordPress database abstraction object. 1408 * @global int $id 1409 * @global WP_Comment $comment Global comment object. 1410 * @global string $user_login 1411 * @global string $user_identity 1412 * @global bool $overridden_cpage 1413 * @global bool $withcomments 1414 * @global string $wp_stylesheet_path Path to current theme's stylesheet directory. 1415 * @global string $wp_template_path Path to current theme's template directory. 1416 * 1417 * @param string $file Optional. The file to load. Default '/comments.php'. 1418 * @param bool $separate_comments Optional. Whether to separate the comments by comment type. 1419 * Default false. 1420 */ 1421 function comments_template( $file = '/comments.php', $separate_comments = false ) { 1422 global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_identity, $overridden_cpage, $wp_stylesheet_path, $wp_template_path; 1423 1424 if ( ! ( is_single() || is_page() || $withcomments ) || empty( $post ) ) { 1425 return; 1426 } 1427 1428 if ( empty( $file ) ) { 1429 $file = '/comments.php'; 1430 } 1431 1432 $req = get_option( 'require_name_email' ); 1433 1434 /* 1435 * Comment author information fetched from the comment cookies. 1436 */ 1437 $commenter = wp_get_current_commenter(); 1438 1439 /* 1440 * The name of the current comment author escaped for use in attributes. 1441 * Escaped by sanitize_comment_cookies(). 1442 */ 1443 $comment_author = $commenter['comment_author']; 1444 1445 /* 1446 * The email address of the current comment author escaped for use in attributes. 1447 * Escaped by sanitize_comment_cookies(). 1448 */ 1449 $comment_author_email = $commenter['comment_author_email']; 1450 1451 /* 1452 * The URL of the current comment author escaped for use in attributes. 1453 */ 1454 $comment_author_url = esc_url( $commenter['comment_author_url'] ); 1455 1456 $comment_args = array( 1457 'orderby' => 'comment_date_gmt', 1458 'order' => 'ASC', 1459 'status' => 'approve', 1460 'post_id' => $post->ID, 1461 'no_found_rows' => false, 1462 ); 1463 1464 if ( get_option( 'thread_comments' ) ) { 1465 $comment_args['hierarchical'] = 'threaded'; 1466 } else { 1467 $comment_args['hierarchical'] = false; 1468 } 1469 1470 if ( is_user_logged_in() ) { 1471 $comment_args['include_unapproved'] = array( get_current_user_id() ); 1472 } else { 1473 $unapproved_email = wp_get_unapproved_comment_author_email(); 1474 1475 if ( $unapproved_email ) { 1476 $comment_args['include_unapproved'] = array( $unapproved_email ); 1477 } 1478 } 1479 1480 $per_page = 0; 1481 if ( get_option( 'page_comments' ) ) { 1482 $per_page = (int) get_query_var( 'comments_per_page' ); 1483 if ( 0 === $per_page ) { 1484 $per_page = (int) get_option( 'comments_per_page' ); 1485 } 1486 1487 $comment_args['number'] = $per_page; 1488 $page = (int) get_query_var( 'cpage' ); 1489 1490 if ( $page ) { 1491 $comment_args['offset'] = ( $page - 1 ) * $per_page; 1492 } elseif ( 'oldest' === get_option( 'default_comments_page' ) ) { 1493 $comment_args['offset'] = 0; 1494 } else { 1495 // If fetching the first page of 'newest', we need a top-level comment count. 1496 $top_level_query = new WP_Comment_Query(); 1497 $top_level_args = array( 1498 'count' => true, 1499 'orderby' => false, 1500 'post_id' => $post->ID, 1501 'status' => 'approve', 1502 ); 1503 1504 if ( $comment_args['hierarchical'] ) { 1505 $top_level_args['parent'] = 0; 1506 } 1507 1508 if ( isset( $comment_args['include_unapproved'] ) ) { 1509 $top_level_args['include_unapproved'] = $comment_args['include_unapproved']; 1510 } 1511 1512 /** 1513 * Filters the arguments used in the top level comments query. 1514 * 1515 * @since 5.6.0 1516 * 1517 * @see WP_Comment_Query::__construct() 1518 * 1519 * @param array $top_level_args { 1520 * The top level query arguments for the comments template. 1521 * 1522 * @type bool $count Whether to return a comment count. 1523 * @type string|array $orderby The field(s) to order by. 1524 * @type int $post_id The post ID. 1525 * @type string|array $status The comment status to limit results by. 1526 * } 1527 */ 1528 $top_level_args = apply_filters( 'comments_template_top_level_query_args', $top_level_args ); 1529 1530 $top_level_count = $top_level_query->query( $top_level_args ); 1531 1532 $comment_args['offset'] = ( (int) ceil( $top_level_count / $per_page ) - 1 ) * $per_page; 1533 } 1534 } 1535 1536 /** 1537 * Filters the arguments used to query comments in comments_template(). 1538 * 1539 * @since 4.5.0 1540 * 1541 * @see WP_Comment_Query::__construct() 1542 * 1543 * @param array $comment_args { 1544 * Array of WP_Comment_Query arguments. 1545 * 1546 * @type string|array $orderby Field(s) to order by. 1547 * @type string $order Order of results. Accepts 'ASC' or 'DESC'. 1548 * @type string $status Comment status. 1549 * @type array $include_unapproved Array of IDs or email addresses whose unapproved comments 1550 * will be included in results. 1551 * @type int $post_id ID of the post. 1552 * @type bool $no_found_rows Whether to refrain from querying for found rows. 1553 * @type bool $update_comment_meta_cache Whether to prime cache for comment meta. 1554 * @type bool|string $hierarchical Whether to query for comments hierarchically. 1555 * @type int $offset Comment offset. 1556 * @type int $number Number of comments to fetch. 1557 * } 1558 */ 1559 $comment_args = apply_filters( 'comments_template_query_args', $comment_args ); 1560 1561 $comment_query = new WP_Comment_Query( $comment_args ); 1562 $_comments = $comment_query->comments; 1563 1564 // Trees must be flattened before they're passed to the walker. 1565 if ( $comment_args['hierarchical'] ) { 1566 $comments_flat = array(); 1567 foreach ( $_comments as $_comment ) { 1568 $comments_flat[] = $_comment; 1569 $comment_children = $_comment->get_children( 1570 array( 1571 'format' => 'flat', 1572 'status' => $comment_args['status'], 1573 'orderby' => $comment_args['orderby'], 1574 ) 1575 ); 1576 1577 foreach ( $comment_children as $comment_child ) { 1578 $comments_flat[] = $comment_child; 1579 } 1580 } 1581 } else { 1582 $comments_flat = $_comments; 1583 } 1584 1585 /** 1586 * Filters the comments array. 1587 * 1588 * @since 2.1.0 1589 * 1590 * @param array $comments Array of comments supplied to the comments template. 1591 * @param int $post_id Post ID. 1592 */ 1593 $wp_query->comments = apply_filters( 'comments_array', $comments_flat, $post->ID ); 1594 1595 $comments = &$wp_query->comments; 1596 $wp_query->comment_count = count( $wp_query->comments ); 1597 $wp_query->max_num_comment_pages = $comment_query->max_num_pages; 1598 1599 if ( $separate_comments ) { 1600 $wp_query->comments_by_type = separate_comments( $comments ); 1601 $comments_by_type = &$wp_query->comments_by_type; 1602 } else { 1603 $wp_query->comments_by_type = array(); 1604 } 1605 1606 $overridden_cpage = false; 1607 1608 if ( '' == get_query_var( 'cpage' ) && $wp_query->max_num_comment_pages > 1 ) { 1609 set_query_var( 'cpage', 'newest' === get_option( 'default_comments_page' ) ? get_comment_pages_count() : 1 ); 1610 $overridden_cpage = true; 1611 } 1612 1613 if ( ! defined( 'COMMENTS_TEMPLATE' ) ) { 1614 define( 'COMMENTS_TEMPLATE', true ); 1615 } 1616 1617 $theme_template = trailingslashit( $wp_stylesheet_path ) . $file; 1618 1619 /** 1620 * Filters the path to the theme template file used for the comments template. 1621 * 1622 * @since 1.5.1 1623 * 1624 * @param string $theme_template The path to the theme template file. 1625 */ 1626 $include = apply_filters( 'comments_template', $theme_template ); 1627 1628 if ( file_exists( $include ) ) { 1629 require $include; 1630 } elseif ( file_exists( trailingslashit( $wp_template_path ) . $file ) ) { 1631 require trailingslashit( $wp_template_path ) . $file; 1632 } else { // Backward compat code will be removed in a future release. 1633 require ABSPATH . WPINC . '/theme-compat/comments.php'; 1634 } 1635 } 1636 1637 /** 1638 * Displays the link to the comments for the current post ID. 1639 * 1640 * @since 0.71 1641 * 1642 * @param false|string $zero Optional. String to display when no comments. Default false. 1643 * @param false|string $one Optional. String to display when only one comment is available. Default false. 1644 * @param false|string $more Optional. String to display when there are more than one comment. Default false. 1645 * @param string $css_class Optional. CSS class to use for comments. Default empty. 1646 * @param false|string $none Optional. String to display when comments have been turned off. Default false. 1647 */ 1648 function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) { 1649 $post_id = get_the_ID(); 1650 $post_title = get_the_title(); 1651 $comments_number = get_comments_number( $post_id ); 1652 1653 if ( false === $zero ) { 1654 /* translators: %s: Post title. */ 1655 $zero = sprintf( __( 'No Comments<span class="screen-reader-text"> on %s</span>' ), $post_title ); 1656 } 1657 1658 if ( false === $one ) { 1659 /* translators: %s: Post title. */ 1660 $one = sprintf( __( '1 Comment<span class="screen-reader-text"> on %s</span>' ), $post_title ); 1661 } 1662 1663 if ( false === $more ) { 1664 /* translators: 1: Number of comments, 2: Post title. */ 1665 $more = _n( 1666 '%1$s Comment<span class="screen-reader-text"> on %2$s</span>', 1667 '%1$s Comments<span class="screen-reader-text"> on %2$s</span>', 1668 $comments_number 1669 ); 1670 $more = sprintf( $more, number_format_i18n( $comments_number ), $post_title ); 1671 } 1672 1673 if ( false === $none ) { 1674 /* translators: %s: Post title. */ 1675 $none = sprintf( __( 'Comments Off<span class="screen-reader-text"> on %s</span>' ), $post_title ); 1676 } 1677 1678 if ( 0 == $comments_number && ! comments_open() && ! pings_open() ) { 1679 printf( 1680 '<span%1$s>%2$s</span>', 1681 ! empty( $css_class ) ? ' class="' . esc_attr( $css_class ) . '"' : '', 1682 $none 1683 ); 1684 return; 1685 } 1686 1687 if ( post_password_required() ) { 1688 _e( 'Enter your password to view comments.' ); 1689 return; 1690 } 1691 1692 if ( 0 == $comments_number ) { 1693 $respond_link = get_permalink() . '#respond'; 1694 /** 1695 * Filters the respond link when a post has no comments. 1696 * 1697 * @since 4.4.0 1698 * 1699 * @param string $respond_link The default response link. 1700 * @param int $post_id The post ID. 1701 */ 1702 $comments_link = apply_filters( 'respond_link', $respond_link, $post_id ); 1703 } else { 1704 $comments_link = get_comments_link(); 1705 } 1706 1707 $link_attributes = ''; 1708 1709 /** 1710 * Filters the comments link attributes for display. 1711 * 1712 * @since 2.5.0 1713 * 1714 * @param string $link_attributes The comments link attributes. Default empty. 1715 */ 1716 $link_attributes = apply_filters( 'comments_popup_link_attributes', $link_attributes ); 1717 1718 printf( 1719 '<a href="%1$s"%2$s%3$s>%4$s</a>', 1720 esc_url( $comments_link ), 1721 ! empty( $css_class ) ? ' class="' . $css_class . '" ' : '', 1722 $link_attributes, 1723 get_comments_number_text( $zero, $one, $more ) 1724 ); 1725 } 1726 1727 /** 1728 * Retrieves HTML content for reply to comment link. 1729 * 1730 * @since 2.7.0 1731 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. 1732 * 1733 * @param array $args { 1734 * Optional. Override default arguments. 1735 * 1736 * @type string $add_below The first part of the selector used to identify the comment to respond below. 1737 * The resulting value is passed as the first parameter to addComment.moveForm(), 1738 * concatenated as $add_below-$comment->comment_ID. Default 'comment'. 1739 * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter 1740 * to addComment.moveForm(), and appended to the link URL as a hash value. 1741 * Default 'respond'. 1742 * @type string $reply_text The text of the Reply link. Default 'Reply'. 1743 * @type string $login_text The text of the link to reply if logged out. Default 'Log in to Reply'. 1744 * @type int $max_depth The max depth of the comment tree. Default 0. 1745 * @type int $depth The depth of the new comment. Must be greater than 0 and less than the value 1746 * of the 'thread_comments_depth' option set in Settings > Discussion. Default 0. 1747 * @type string $before The text or HTML to add before the reply link. Default empty. 1748 * @type string $after The text or HTML to add after the reply link. Default empty. 1749 * } 1750 * @param int|WP_Comment $comment Optional. Comment being replied to. Default current comment. 1751 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. 1752 * Default current post. 1753 * @return string|false|null Link to show comment form, if successful. False, if comments are closed. 1754 */ 1755 function get_comment_reply_link( $args = array(), $comment = null, $post = null ) { 1756 $defaults = array( 1757 'add_below' => 'comment', 1758 'respond_id' => 'respond', 1759 'reply_text' => __( 'Reply' ), 1760 /* translators: Comment reply button text. %s: Comment author name. */ 1761 'reply_to_text' => __( 'Reply to %s' ), 1762 'login_text' => __( 'Log in to Reply' ), 1763 'max_depth' => 0, 1764 'depth' => 0, 1765 'before' => '', 1766 'after' => '', 1767 ); 1768 1769 $args = wp_parse_args( $args, $defaults ); 1770 1771 if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] ) { 1772 return; 1773 } 1774 1775 $comment = get_comment( $comment ); 1776 1777 if ( empty( $comment ) ) { 1778 return; 1779 } 1780 1781 if ( empty( $post ) ) { 1782 $post = $comment->comment_post_ID; 1783 } 1784 1785 $post = get_post( $post ); 1786 1787 if ( ! comments_open( $post->ID ) ) { 1788 return false; 1789 } 1790 1791 if ( get_option( 'page_comments' ) ) { 1792 $permalink = str_replace( '#comment-' . $comment->comment_ID, '', get_comment_link( $comment ) ); 1793 } else { 1794 $permalink = get_permalink( $post->ID ); 1795 } 1796 1797 /** 1798 * Filters the comment reply link arguments. 1799 * 1800 * @since 4.1.0 1801 * 1802 * @param array $args Comment reply link arguments. See get_comment_reply_link() 1803 * for more information on accepted arguments. 1804 * @param WP_Comment $comment The object of the comment being replied to. 1805 * @param WP_Post $post The WP_Post object. 1806 */ 1807 $args = apply_filters( 'comment_reply_link_args', $args, $comment, $post ); 1808 1809 if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) { 1810 $link = sprintf( 1811 '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>', 1812 esc_url( wp_login_url( get_permalink() ) ), 1813 $args['login_text'] 1814 ); 1815 } else { 1816 $data_attributes = array( 1817 'commentid' => $comment->comment_ID, 1818 'postid' => $post->ID, 1819 'belowelement' => $args['add_below'] . '-' . $comment->comment_ID, 1820 'respondelement' => $args['respond_id'], 1821 'replyto' => sprintf( $args['reply_to_text'], get_comment_author( $comment ) ), 1822 ); 1823 1824 $data_attribute_string = ''; 1825 1826 foreach ( $data_attributes as $name => $value ) { 1827 $data_attribute_string .= " data-{$name}=\"" . esc_attr( $value ) . '"'; 1828 } 1829 1830 $data_attribute_string = trim( $data_attribute_string ); 1831 1832 $link = sprintf( 1833 "<a rel='nofollow' class='comment-reply-link' href='%s' %s aria-label='%s'>%s</a>", 1834 esc_url( 1835 add_query_arg( 1836 array( 1837 'replytocom' => $comment->comment_ID, 1838 'unapproved' => false, 1839 'moderation-hash' => false, 1840 ), 1841 $permalink 1842 ) 1843 ) . '#' . $args['respond_id'], 1844 $data_attribute_string, 1845 esc_attr( sprintf( $args['reply_to_text'], get_comment_author( $comment ) ) ), 1846 $args['reply_text'] 1847 ); 1848 } 1849 1850 $comment_reply_link = $args['before'] . $link . $args['after']; 1851 1852 /** 1853 * Filters the comment reply link. 1854 * 1855 * @since 2.7.0 1856 * 1857 * @param string $comment_reply_link The HTML markup for the comment reply link. 1858 * @param array $args An array of arguments overriding the defaults. 1859 * @param WP_Comment $comment The object of the comment being replied. 1860 * @param WP_Post $post The WP_Post object. 1861 */ 1862 return apply_filters( 'comment_reply_link', $comment_reply_link, $args, $comment, $post ); 1863 } 1864 1865 /** 1866 * Displays the HTML content for reply to comment link. 1867 * 1868 * @since 2.7.0 1869 * 1870 * @see get_comment_reply_link() 1871 * 1872 * @param array $args Optional. Override default options. Default empty array. 1873 * @param int|WP_Comment $comment Optional. Comment being replied to. Default current comment. 1874 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. 1875 * Default current post. 1876 */ 1877 function comment_reply_link( $args = array(), $comment = null, $post = null ) { 1878 echo get_comment_reply_link( $args, $comment, $post ); 1879 } 1880 1881 /** 1882 * Retrieves HTML content for reply to post link. 1883 * 1884 * @since 2.7.0 1885 * 1886 * @param array $args { 1887 * Optional. Override default arguments. 1888 * 1889 * @type string $add_below The first part of the selector used to identify the comment to respond below. 1890 * The resulting value is passed as the first parameter to addComment.moveForm(), 1891 * concatenated as $add_below-$comment->comment_ID. Default is 'post'. 1892 * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter 1893 * to addComment.moveForm(), and appended to the link URL as a hash value. 1894 * Default 'respond'. 1895 * @type string $reply_text Text of the Reply link. Default is 'Leave a Comment'. 1896 * @type string $login_text Text of the link to reply if logged out. Default is 'Log in to leave a Comment'. 1897 * @type string $before Text or HTML to add before the reply link. Default empty. 1898 * @type string $after Text or HTML to add after the reply link. Default empty. 1899 * } 1900 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. 1901 * Default current post. 1902 * @return string|false|null Link to show comment form, if successful. False, if comments are closed. 1903 */ 1904 function get_post_reply_link( $args = array(), $post = null ) { 1905 $defaults = array( 1906 'add_below' => 'post', 1907 'respond_id' => 'respond', 1908 'reply_text' => __( 'Leave a Comment' ), 1909 'login_text' => __( 'Log in to leave a Comment' ), 1910 'before' => '', 1911 'after' => '', 1912 ); 1913 1914 $args = wp_parse_args( $args, $defaults ); 1915 1916 $post = get_post( $post ); 1917 1918 if ( ! comments_open( $post->ID ) ) { 1919 return false; 1920 } 1921 1922 if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) { 1923 $link = sprintf( 1924 '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>', 1925 wp_login_url( get_permalink() ), 1926 $args['login_text'] 1927 ); 1928 } else { 1929 $onclick = sprintf( 1930 'return addComment.moveForm( "%1$s-%2$s", "0", "%3$s", "%2$s" )', 1931 $args['add_below'], 1932 $post->ID, 1933 $args['respond_id'] 1934 ); 1935 1936 $link = sprintf( 1937 "<a rel='nofollow' class='comment-reply-link' href='%s' onclick='%s'>%s</a>", 1938 get_permalink( $post->ID ) . '#' . $args['respond_id'], 1939 $onclick, 1940 $args['reply_text'] 1941 ); 1942 } 1943 1944 $post_reply_link = $args['before'] . $link . $args['after']; 1945 1946 /** 1947 * Filters the formatted post comments link HTML. 1948 * 1949 * @since 2.7.0 1950 * 1951 * @param string $post_reply_link The HTML-formatted post comments link. 1952 * @param int|WP_Post $post The post ID or WP_Post object. 1953 */ 1954 return apply_filters( 'post_comments_link', $post_reply_link, $post ); 1955 } 1956 1957 /** 1958 * Displays the HTML content for reply to post link. 1959 * 1960 * @since 2.7.0 1961 * 1962 * @see get_post_reply_link() 1963 * 1964 * @param array $args Optional. Override default options. Default empty array. 1965 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. 1966 * Default current post. 1967 */ 1968 function post_reply_link( $args = array(), $post = null ) { 1969 echo get_post_reply_link( $args, $post ); 1970 } 1971 1972 /** 1973 * Retrieves HTML content for cancel comment reply link. 1974 * 1975 * @since 2.7.0 1976 * @since 6.2.0 Added the `$post` parameter. 1977 * 1978 * @param string $link_text Optional. Text to display for cancel reply link. If empty, 1979 * defaults to 'Click here to cancel reply'. Default empty. 1980 * @param int|WP_Post|null $post Optional. The post the comment thread is being 1981 * displayed for. Defaults to the current global post. 1982 * @return string 1983 */ 1984 function get_cancel_comment_reply_link( $link_text = '', $post = null ) { 1985 if ( empty( $link_text ) ) { 1986 $link_text = __( 'Click here to cancel reply.' ); 1987 } 1988 1989 $post = get_post( $post ); 1990 $reply_to_id = $post ? _get_comment_reply_id( $post->ID ) : 0; 1991 $link_style = 0 !== $reply_to_id ? '' : ' style="display:none;"'; 1992 $link_url = esc_url( remove_query_arg( array( 'replytocom', 'unapproved', 'moderation-hash' ) ) ) . '#respond'; 1993 1994 $cancel_comment_reply_link = sprintf( 1995 '<a rel="nofollow" id="cancel-comment-reply-link" href="%1$s"%2$s>%3$s</a>', 1996 $link_url, 1997 $link_style, 1998 $link_text 1999 ); 2000 2001 /** 2002 * Filters the cancel comment reply link HTML. 2003 * 2004 * @since 2.7.0 2005 * 2006 * @param string $cancel_comment_reply_link The HTML-formatted cancel comment reply link. 2007 * @param string $link_url Cancel comment reply link URL. 2008 * @param string $link_text Cancel comment reply link text. 2009 */ 2010 return apply_filters( 'cancel_comment_reply_link', $cancel_comment_reply_link, $link_url, $link_text ); 2011 } 2012 2013 /** 2014 * Displays HTML content for cancel comment reply link. 2015 * 2016 * @since 2.7.0 2017 * 2018 * @param string $link_text Optional. Text to display for cancel reply link. If empty, 2019 * defaults to 'Click here to cancel reply'. Default empty. 2020 */ 2021 function cancel_comment_reply_link( $link_text = '' ) { 2022 echo get_cancel_comment_reply_link( $link_text ); 2023 } 2024 2025 /** 2026 * Retrieves hidden input HTML for replying to comments. 2027 * 2028 * @since 3.0.0 2029 * @since 6.2.0 Renamed `$post_id` to `$post` and added WP_Post support. 2030 * 2031 * @param int|WP_Post|null $post Optional. The post the comment is being displayed for. 2032 * Defaults to the current global post. 2033 * @return string Hidden input HTML for replying to comments. 2034 */ 2035 function get_comment_id_fields( $post = null ) { 2036 $post = get_post( $post ); 2037 if ( ! $post ) { 2038 return ''; 2039 } 2040 2041 $post_id = $post->ID; 2042 $reply_to_id = _get_comment_reply_id( $post_id ); 2043 2044 $comment_id_fields = "<input type='hidden' name='comment_post_ID' value='$post_id' id='comment_post_ID' />\n"; 2045 $comment_id_fields .= "<input type='hidden' name='comment_parent' id='comment_parent' value='$reply_to_id' />\n"; 2046 2047 /** 2048 * Filters the returned comment ID fields. 2049 * 2050 * @since 3.0.0 2051 * 2052 * @param string $comment_id_fields The HTML-formatted hidden ID field comment elements. 2053 * @param int $post_id The post ID. 2054 * @param int $reply_to_id The ID of the comment being replied to. 2055 */ 2056 return apply_filters( 'comment_id_fields', $comment_id_fields, $post_id, $reply_to_id ); 2057 } 2058 2059 /** 2060 * Outputs hidden input HTML for replying to comments. 2061 * 2062 * Adds two hidden inputs to the comment form to identify the `comment_post_ID` 2063 * and `comment_parent` values for threaded comments. 2064 * 2065 * This tag must be within the `<form>` section of the `comments.php` template. 2066 * 2067 * @since 2.7.0 2068 * @since 6.2.0 Renamed `$post_id` to `$post` and added WP_Post support. 2069 * 2070 * @see get_comment_id_fields() 2071 * 2072 * @param int|WP_Post|null $post Optional. The post the comment is being displayed for. 2073 * Defaults to the current global post. 2074 */ 2075 function comment_id_fields( $post = null ) { 2076 echo get_comment_id_fields( $post ); 2077 } 2078 2079 /** 2080 * Displays text based on comment reply status. 2081 * 2082 * Only affects users with JavaScript disabled. 2083 * 2084 * @internal The $comment global must be present to allow template tags access to the current 2085 * comment. See https://core.trac.wordpress.org/changeset/36512. 2086 * 2087 * @since 2.7.0 2088 * @since 6.2.0 Added the `$post` parameter. 2089 * 2090 * @global WP_Comment $comment Global comment object. 2091 * 2092 * @param string|false $no_reply_text Optional. Text to display when not replying to a comment. 2093 * Default false. 2094 * @param string|false $reply_text Optional. Text to display when replying to a comment. 2095 * Default false. Accepts "%s" for the author of the comment 2096 * being replied to. 2097 * @param bool $link_to_parent Optional. Boolean to control making the author's name a link 2098 * to their comment. Default true. 2099 * @param int|WP_Post|null $post Optional. The post that the comment form is being displayed for. 2100 * Defaults to the current global post. 2101 */ 2102 function comment_form_title( $no_reply_text = false, $reply_text = false, $link_to_parent = true, $post = null ) { 2103 global $comment; 2104 2105 if ( false === $no_reply_text ) { 2106 $no_reply_text = __( 'Leave a Reply' ); 2107 } 2108 2109 if ( false === $reply_text ) { 2110 /* translators: %s: Author of the comment being replied to. */ 2111 $reply_text = __( 'Leave a Reply to %s' ); 2112 } 2113 2114 $post = get_post( $post ); 2115 if ( ! $post ) { 2116 echo $no_reply_text; 2117 return; 2118 } 2119 2120 $reply_to_id = _get_comment_reply_id( $post->ID ); 2121 2122 if ( 0 === $reply_to_id ) { 2123 echo $no_reply_text; 2124 return; 2125 } 2126 2127 // Sets the global so that template tags can be used in the comment form. 2128 $comment = get_comment( $reply_to_id ); 2129 2130 if ( $link_to_parent ) { 2131 $comment_author = sprintf( 2132 '<a href="#comment-%1$s">%2$s</a>', 2133 get_comment_ID(), 2134 get_comment_author( $reply_to_id ) 2135 ); 2136 } else { 2137 $comment_author = get_comment_author( $reply_to_id ); 2138 } 2139 2140 printf( $reply_text, $comment_author ); 2141 } 2142 2143 /** 2144 * Gets the comment's reply to ID from the $_GET['replytocom']. 2145 * 2146 * @since 6.2.0 2147 * 2148 * @access private 2149 * 2150 * @param int|WP_Post $post The post the comment is being displayed for. 2151 * Defaults to the current global post. 2152 * @return int Comment's reply to ID. 2153 */ 2154 function _get_comment_reply_id( $post = null ) { 2155 $post = get_post( $post ); 2156 2157 if ( ! $post || ! isset( $_GET['replytocom'] ) || ! is_numeric( $_GET['replytocom'] ) ) { 2158 return 0; 2159 } 2160 2161 $reply_to_id = (int) $_GET['replytocom']; 2162 2163 /* 2164 * Validate the comment. 2165 * Bail out if it does not exist, is not approved, or its 2166 * `comment_post_ID` does not match the given post ID. 2167 */ 2168 $comment = get_comment( $reply_to_id ); 2169 2170 if ( 2171 ! $comment instanceof WP_Comment || 2172 0 === (int) $comment->comment_approved || 2173 $post->ID !== (int) $comment->comment_post_ID 2174 ) { 2175 return 0; 2176 } 2177 2178 return $reply_to_id; 2179 } 2180 2181 /** 2182 * Displays a list of comments. 2183 * 2184 * Used in the comments.php template to list comments for a particular post. 2185 * 2186 * @since 2.7.0 2187 * 2188 * @see WP_Query::$comments 2189 * 2190 * @global WP_Query $wp_query WordPress Query object. 2191 * @global int $comment_alt 2192 * @global int $comment_depth 2193 * @global int $comment_thread_alt 2194 * @global bool $overridden_cpage 2195 * @global bool $in_comment_loop 2196 * 2197 * @param string|array $args { 2198 * Optional. Formatting options. 2199 * 2200 * @type object $walker Instance of a Walker class to list comments. Default null. 2201 * @type int $max_depth The maximum comments depth. Default empty. 2202 * @type string $style The style of list ordering. Accepts 'ul', 'ol', or 'div'. 2203 * 'div' will result in no additional list markup. Default 'ul'. 2204 * @type callable $callback Callback function to use. Default null. 2205 * @type callable $end-callback Callback function to use at the end. Default null. 2206 * @type string $type Type of comments to list. Accepts 'all', 'comment', 2207 * 'pingback', 'trackback', 'pings'. Default 'all'. 2208 * @type int $page Page ID to list comments for. Default empty. 2209 * @type int $per_page Number of comments to list per page. Default empty. 2210 * @type int $avatar_size Height and width dimensions of the avatar size. Default 32. 2211 * @type bool $reverse_top_level Ordering of the listed comments. If true, will display 2212 * newest comments first. Default null. 2213 * @type bool $reverse_children Whether to reverse child comments in the list. Default null. 2214 * @type string $format How to format the comments list. Accepts 'html5', 'xhtml'. 2215 * Default 'html5' if the theme supports it. 2216 * @type bool $short_ping Whether to output short pings. Default false. 2217 * @type bool $echo Whether to echo the output or return it. Default true. 2218 * } 2219 * @param WP_Comment[] $comments Optional. Array of WP_Comment objects. Default null. 2220 * @return void|string Void if 'echo' argument is true, or no comments to list. 2221 * Otherwise, HTML list of comments. 2222 */ 2223 function wp_list_comments( $args = array(), $comments = null ) { 2224 global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop; 2225 2226 $in_comment_loop = true; 2227 2228 $comment_alt = 0; 2229 $comment_thread_alt = 0; 2230 $comment_depth = 1; 2231 2232 $defaults = array( 2233 'walker' => null, 2234 'max_depth' => '', 2235 'style' => 'ul', 2236 'callback' => null, 2237 'end-callback' => null, 2238 'type' => 'all', 2239 'page' => '', 2240 'per_page' => '', 2241 'avatar_size' => 32, 2242 'reverse_top_level' => null, 2243 'reverse_children' => '', 2244 'format' => current_theme_supports( 'html5', 'comment-list' ) ? 'html5' : 'xhtml', 2245 'short_ping' => false, 2246 'echo' => true, 2247 ); 2248 2249 $parsed_args = wp_parse_args( $args, $defaults ); 2250 2251 /** 2252 * Filters the arguments used in retrieving the comment list. 2253 * 2254 * @since 4.0.0 2255 * 2256 * @see wp_list_comments() 2257 * 2258 * @param array $parsed_args An array of arguments for displaying comments. 2259 */ 2260 $parsed_args = apply_filters( 'wp_list_comments_args', $parsed_args ); 2261 2262 // Figure out what comments we'll be looping through ($_comments). 2263 if ( null !== $comments ) { 2264 $comments = (array) $comments; 2265 if ( empty( $comments ) ) { 2266 return; 2267 } 2268 if ( 'all' !== $parsed_args['type'] ) { 2269 $comments_by_type = separate_comments( $comments ); 2270 if ( empty( $comments_by_type[ $parsed_args['type'] ] ) ) { 2271 return; 2272 } 2273 $_comments = $comments_by_type[ $parsed_args['type'] ]; 2274 } else { 2275 $_comments = $comments; 2276 } 2277 } else { 2278 /* 2279 * If 'page' or 'per_page' has been passed, and does not match what's in $wp_query, 2280 * perform a separate comment query and allow Walker_Comment to paginate. 2281 */ 2282 if ( $parsed_args['page'] || $parsed_args['per_page'] ) { 2283 $current_cpage = get_query_var( 'cpage' ); 2284 if ( ! $current_cpage ) { 2285 $current_cpage = 'newest' === get_option( 'default_comments_page' ) ? 1 : $wp_query->max_num_comment_pages; 2286 } 2287 2288 $current_per_page = get_query_var( 'comments_per_page' ); 2289 if ( $parsed_args['page'] != $current_cpage || $parsed_args['per_page'] != $current_per_page ) { 2290 $comment_args = array( 2291 'post_id' => get_the_ID(), 2292 'orderby' => 'comment_date_gmt', 2293 'order' => 'ASC', 2294 'status' => 'approve', 2295 ); 2296 2297 if ( is_user_logged_in() ) { 2298 $comment_args['include_unapproved'] = array( get_current_user_id() ); 2299 } else { 2300 $unapproved_email = wp_get_unapproved_comment_author_email(); 2301 2302 if ( $unapproved_email ) { 2303 $comment_args['include_unapproved'] = array( $unapproved_email ); 2304 } 2305 } 2306 2307 $comments = get_comments( $comment_args ); 2308 2309 if ( 'all' !== $parsed_args['type'] ) { 2310 $comments_by_type = separate_comments( $comments ); 2311 if ( empty( $comments_by_type[ $parsed_args['type'] ] ) ) { 2312 return; 2313 } 2314 2315 $_comments = $comments_by_type[ $parsed_args['type'] ]; 2316 } else { 2317 $_comments = $comments; 2318 } 2319 } 2320 2321 // Otherwise, fall back on the comments from `$wp_query->comments`. 2322 } else { 2323 if ( empty( $wp_query->comments ) ) { 2324 return; 2325 } 2326 if ( 'all' !== $parsed_args['type'] ) { 2327 if ( empty( $wp_query->comments_by_type ) ) { 2328 $wp_query->comments_by_type = separate_comments( $wp_query->comments ); 2329 } 2330 if ( empty( $wp_query->comments_by_type[ $parsed_args['type'] ] ) ) { 2331 return; 2332 } 2333 $_comments = $wp_query->comments_by_type[ $parsed_args['type'] ]; 2334 } else { 2335 $_comments = $wp_query->comments; 2336 } 2337 2338 if ( $wp_query->max_num_comment_pages ) { 2339 $default_comments_page = get_option( 'default_comments_page' ); 2340 $cpage = get_query_var( 'cpage' ); 2341 if ( 'newest' === $default_comments_page ) { 2342 $parsed_args['cpage'] = $cpage; 2343 2344 /* 2345 * When first page shows oldest comments, post permalink is the same as 2346 * the comment permalink. 2347 */ 2348 } elseif ( 1 == $cpage ) { 2349 $parsed_args['cpage'] = ''; 2350 } else { 2351 $parsed_args['cpage'] = $cpage; 2352 } 2353 2354 $parsed_args['page'] = 0; 2355 $parsed_args['per_page'] = 0; 2356 } 2357 } 2358 } 2359 2360 if ( '' === $parsed_args['per_page'] && get_option( 'page_comments' ) ) { 2361 $parsed_args['per_page'] = get_query_var( 'comments_per_page' ); 2362 } 2363 2364 if ( empty( $parsed_args['per_page'] ) ) { 2365 $parsed_args['per_page'] = 0; 2366 $parsed_args['page'] = 0; 2367 } 2368 2369 if ( '' === $parsed_args['max_depth'] ) { 2370 if ( get_option( 'thread_comments' ) ) { 2371 $parsed_args['max_depth'] = get_option( 'thread_comments_depth' ); 2372 } else { 2373 $parsed_args['max_depth'] = -1; 2374 } 2375 } 2376 2377 if ( '' === $parsed_args['page'] ) { 2378 if ( empty( $overridden_cpage ) ) { 2379 $parsed_args['page'] = get_query_var( 'cpage' ); 2380 } else { 2381 $threaded = ( -1 != $parsed_args['max_depth'] ); 2382 $parsed_args['page'] = ( 'newest' === get_option( 'default_comments_page' ) ) ? get_comment_pages_count( $_comments, $parsed_args['per_page'], $threaded ) : 1; 2383 set_query_var( 'cpage', $parsed_args['page'] ); 2384 } 2385 } 2386 // Validation check. 2387 $parsed_args['page'] = (int) $parsed_args['page']; 2388 if ( 0 == $parsed_args['page'] && 0 != $parsed_args['per_page'] ) { 2389 $parsed_args['page'] = 1; 2390 } 2391 2392 if ( null === $parsed_args['reverse_top_level'] ) { 2393 $parsed_args['reverse_top_level'] = ( 'desc' === get_option( 'comment_order' ) ); 2394 } 2395 2396 if ( empty( $parsed_args['walker'] ) ) { 2397 $walker = new Walker_Comment(); 2398 } else { 2399 $walker = $parsed_args['walker']; 2400 } 2401 2402 $output = $walker->paged_walk( $_comments, $parsed_args['max_depth'], $parsed_args['page'], $parsed_args['per_page'], $parsed_args ); 2403 2404 $in_comment_loop = false; 2405 2406 if ( $parsed_args['echo'] ) { 2407 echo $output; 2408 } else { 2409 return $output; 2410 } 2411 } 2412 2413 /** 2414 * Outputs a complete commenting form for use within a template. 2415 * 2416 * Most strings and form fields may be controlled through the `$args` array passed 2417 * into the function, while you may also choose to use the {@see 'comment_form_default_fields'} 2418 * filter to modify the array of default fields if you'd just like to add a new 2419 * one or remove a single field. All fields are also individually passed through 2420 * a filter of the {@see 'comment_form_field_$name'} where `$name` is the key used 2421 * in the array of fields. 2422 * 2423 * @since 3.0.0 2424 * @since 4.1.0 Introduced the 'class_submit' argument. 2425 * @since 4.2.0 Introduced the 'submit_button' and 'submit_fields' arguments. 2426 * @since 4.4.0 Introduced the 'class_form', 'title_reply_before', 'title_reply_after', 2427 * 'cancel_reply_before', and 'cancel_reply_after' arguments. 2428 * @since 4.5.0 The 'author', 'email', and 'url' form fields are limited to 245, 100, 2429 * and 200 characters, respectively. 2430 * @since 4.6.0 Introduced the 'action' argument. 2431 * @since 4.9.6 Introduced the 'cookies' default comment field. 2432 * @since 5.5.0 Introduced the 'class_container' argument. 2433 * 2434 * @param array $args { 2435 * Optional. Default arguments and form fields to override. 2436 * 2437 * @type array $fields { 2438 * Default comment fields, filterable by default via the {@see 'comment_form_default_fields'} hook. 2439 * 2440 * @type string $author Comment author field HTML. 2441 * @type string $email Comment author email field HTML. 2442 * @type string $url Comment author URL field HTML. 2443 * @type string $cookies Comment cookie opt-in field HTML. 2444 * } 2445 * @type string $comment_field The comment textarea field HTML. 2446 * @type string $must_log_in HTML element for a 'must be logged in to comment' message. 2447 * @type string $logged_in_as The HTML for the 'logged in as [user]' message, the Edit profile link, 2448 * and the Log out link. 2449 * @type string $comment_notes_before HTML element for a message displayed before the comment fields 2450 * if the user is not logged in. 2451 * Default 'Your email address will not be published.'. 2452 * @type string $comment_notes_after HTML element for a message displayed after the textarea field. 2453 * @type string $action The comment form element action attribute. Default '/wp-comments-post.php'. 2454 * @type string $id_form The comment form element id attribute. Default 'commentform'. 2455 * @type string $id_submit The comment submit element id attribute. Default 'submit'. 2456 * @type string $class_container The comment form container class attribute. Default 'comment-respond'. 2457 * @type string $class_form The comment form element class attribute. Default 'comment-form'. 2458 * @type string $class_submit The comment submit element class attribute. Default 'submit'. 2459 * @type string $name_submit The comment submit element name attribute. Default 'submit'. 2460 * @type string $title_reply The translatable 'reply' button label. Default 'Leave a Reply'. 2461 * @type string $title_reply_to The translatable 'reply-to' button label. Default 'Leave a Reply to %s', 2462 * where %s is the author of the comment being replied to. 2463 * @type string $title_reply_before HTML displayed before the comment form title. 2464 * Default: '<h3 id="reply-title" class="comment-reply-title">'. 2465 * @type string $title_reply_after HTML displayed after the comment form title. 2466 * Default: '</h3>'. 2467 * @type string $cancel_reply_before HTML displayed before the cancel reply link. 2468 * @type string $cancel_reply_after HTML displayed after the cancel reply link. 2469 * @type string $cancel_reply_link The translatable 'cancel reply' button label. Default 'Cancel reply'. 2470 * @type string $label_submit The translatable 'submit' button label. Default 'Post a comment'. 2471 * @type string $submit_button HTML format for the Submit button. 2472 * Default: '<input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />'. 2473 * @type string $submit_field HTML format for the markup surrounding the Submit button and comment hidden 2474 * fields. Default: '<p class="form-submit">%1$s %2$s</p>', where %1$s is the 2475 * submit button markup and %2$s is the comment hidden fields. 2476 * @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'. 2477 * } 2478 * @param int|WP_Post $post Optional. Post ID or WP_Post object to generate the form for. Default current post. 2479 */ 2480 function comment_form( $args = array(), $post = null ) { 2481 $post = get_post( $post ); 2482 2483 // Exit the function if the post is invalid or comments are closed. 2484 if ( ! $post || ! comments_open( $post ) ) { 2485 /** 2486 * Fires after the comment form if comments are closed. 2487 * 2488 * For backward compatibility, this action also fires if comment_form() 2489 * is called with an invalid post object or ID. 2490 * 2491 * @since 3.0.0 2492 */ 2493 do_action( 'comment_form_comments_closed' ); 2494 2495 return; 2496 } 2497 2498 $post_id = $post->ID; 2499 $commenter = wp_get_current_commenter(); 2500 $user = wp_get_current_user(); 2501 $user_identity = $user->exists() ? $user->display_name : ''; 2502 2503 $args = wp_parse_args( $args ); 2504 if ( ! isset( $args['format'] ) ) { 2505 $args['format'] = current_theme_supports( 'html5', 'comment-form' ) ? 'html5' : 'xhtml'; 2506 } 2507 2508 $req = get_option( 'require_name_email' ); 2509 $html5 = 'html5' === $args['format']; 2510 2511 // Define attributes in HTML5 or XHTML syntax. 2512 $required_attribute = ( $html5 ? ' required' : ' required="required"' ); 2513 $checked_attribute = ( $html5 ? ' checked' : ' checked="checked"' ); 2514 2515 // Identify required fields visually and create a message about the indicator. 2516 $required_indicator = ' ' . wp_required_field_indicator(); 2517 $required_text = ' ' . wp_required_field_message(); 2518 2519 $fields = array( 2520 'author' => sprintf( 2521 '<p class="comment-form-author">%s %s</p>', 2522 sprintf( 2523 '<label for="author">%s%s</label>', 2524 __( 'Name' ), 2525 ( $req ? $required_indicator : '' ) 2526 ), 2527 sprintf( 2528 '<input id="author" name="author" type="text" value="%s" size="30" maxlength="245" autocomplete="name"%s />', 2529 esc_attr( $commenter['comment_author'] ), 2530 ( $req ? $required_attribute : '' ) 2531 ) 2532 ), 2533 'email' => sprintf( 2534 '<p class="comment-form-email">%s %s</p>', 2535 sprintf( 2536 '<label for="email">%s%s</label>', 2537 __( 'Email' ), 2538 ( $req ? $required_indicator : '' ) 2539 ), 2540 sprintf( 2541 '<input id="email" name="email" %s value="%s" size="30" maxlength="100" aria-describedby="email-notes" autocomplete="email"%s />', 2542 ( $html5 ? 'type="email"' : 'type="text"' ), 2543 esc_attr( $commenter['comment_author_email'] ), 2544 ( $req ? $required_attribute : '' ) 2545 ) 2546 ), 2547 'url' => sprintf( 2548 '<p class="comment-form-url">%s %s</p>', 2549 sprintf( 2550 '<label for="url">%s</label>', 2551 __( 'Website' ) 2552 ), 2553 sprintf( 2554 '<input id="url" name="url" %s value="%s" size="30" maxlength="200" autocomplete="url" />', 2555 ( $html5 ? 'type="url"' : 'type="text"' ), 2556 esc_attr( $commenter['comment_author_url'] ) 2557 ) 2558 ), 2559 ); 2560 2561 if ( has_action( 'set_comment_cookies', 'wp_set_comment_cookies' ) && get_option( 'show_comments_cookies_opt_in' ) ) { 2562 $consent = empty( $commenter['comment_author_email'] ) ? '' : $checked_attribute; 2563 2564 $fields['cookies'] = sprintf( 2565 '<p class="comment-form-cookies-consent">%s %s</p>', 2566 sprintf( 2567 '<input id="wp-comment-cookies-consent" name="wp-comment-cookies-consent" type="checkbox" value="yes"%s />', 2568 $consent 2569 ), 2570 sprintf( 2571 '<label for="wp-comment-cookies-consent">%s</label>', 2572 __( 'Save my name, email, and website in this browser for the next time I comment.' ) 2573 ) 2574 ); 2575 2576 // Ensure that the passed fields include cookies consent. 2577 if ( isset( $args['fields'] ) && ! isset( $args['fields']['cookies'] ) ) { 2578 $args['fields']['cookies'] = $fields['cookies']; 2579 } 2580 } 2581 2582 /** 2583 * Filters the default comment form fields. 2584 * 2585 * @since 3.0.0 2586 * 2587 * @param string[] $fields Array of the default comment fields. 2588 */ 2589 $fields = apply_filters( 'comment_form_default_fields', $fields ); 2590 2591 $defaults = array( 2592 'fields' => $fields, 2593 'comment_field' => sprintf( 2594 '<p class="comment-form-comment">%s %s</p>', 2595 sprintf( 2596 '<label for="comment">%s%s</label>', 2597 _x( 'Comment', 'noun' ), 2598 $required_indicator 2599 ), 2600 '<textarea id="comment" name="comment" cols="45" rows="8" maxlength="65525"' . $required_attribute . '></textarea>' 2601 ), 2602 'must_log_in' => sprintf( 2603 '<p class="must-log-in">%s</p>', 2604 sprintf( 2605 /* translators: %s: Login URL. */ 2606 __( 'You must be <a href="%s">logged in</a> to post a comment.' ), 2607 /** This filter is documented in wp-includes/link-template.php */ 2608 wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) ) 2609 ) 2610 ), 2611 'logged_in_as' => sprintf( 2612 '<p class="logged-in-as">%s%s</p>', 2613 sprintf( 2614 /* translators: 1: User name, 2: Edit user link, 3: Logout URL. */ 2615 __( 'Logged in as %1$s. <a href="%2$s">Edit your profile</a>. <a href="%3$s">Log out?</a>' ), 2616 $user_identity, 2617 get_edit_user_link(), 2618 /** This filter is documented in wp-includes/link-template.php */ 2619 wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) ) 2620 ), 2621 $required_text 2622 ), 2623 'comment_notes_before' => sprintf( 2624 '<p class="comment-notes">%s%s</p>', 2625 sprintf( 2626 '<span id="email-notes">%s</span>', 2627 __( 'Your email address will not be published.' ) 2628 ), 2629 $required_text 2630 ), 2631 'comment_notes_after' => '', 2632 'action' => site_url( '/wp-comments-post.php' ), 2633 'id_form' => 'commentform', 2634 'id_submit' => 'submit', 2635 'class_container' => 'comment-respond', 2636 'class_form' => 'comment-form', 2637 'class_submit' => 'submit', 2638 'name_submit' => 'submit', 2639 'title_reply' => __( 'Leave a Reply' ), 2640 /* translators: %s: Author of the comment being replied to. */ 2641 'title_reply_to' => __( 'Leave a Reply to %s' ), 2642 'title_reply_before' => '<h3 id="reply-title" class="comment-reply-title">', 2643 'title_reply_after' => '</h3>', 2644 'cancel_reply_before' => ' <small>', 2645 'cancel_reply_after' => '</small>', 2646 'cancel_reply_link' => __( 'Cancel reply' ), 2647 'label_submit' => __( 'Post Comment' ), 2648 'submit_button' => '<input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />', 2649 'submit_field' => '<p class="form-submit">%1$s %2$s</p>', 2650 'format' => 'xhtml', 2651 ); 2652 2653 /** 2654 * Filters the comment form default arguments. 2655 * 2656 * Use {@see 'comment_form_default_fields'} to filter the comment fields. 2657 * 2658 * @since 3.0.0 2659 * 2660 * @param array $defaults The default comment form arguments. 2661 */ 2662 $args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) ); 2663 2664 // Ensure that the filtered arguments contain all required default values. 2665 $args = array_merge( $defaults, $args ); 2666 2667 // Remove `aria-describedby` from the email field if there's no associated description. 2668 if ( isset( $args['fields']['email'] ) && ! str_contains( $args['comment_notes_before'], 'id="email-notes"' ) ) { 2669 $args['fields']['email'] = str_replace( 2670 ' aria-describedby="email-notes"', 2671 '', 2672 $args['fields']['email'] 2673 ); 2674 } 2675 2676 /** 2677 * Fires before the comment form. 2678 * 2679 * @since 3.0.0 2680 */ 2681 do_action( 'comment_form_before' ); 2682 ?> 2683 <div id="respond" class="<?php echo esc_attr( $args['class_container'] ); ?>"> 2684 <?php 2685 echo $args['title_reply_before']; 2686 2687 comment_form_title( $args['title_reply'], $args['title_reply_to'], true, $post_id ); 2688 2689 if ( get_option( 'thread_comments' ) ) { 2690 echo $args['cancel_reply_before']; 2691 2692 cancel_comment_reply_link( $args['cancel_reply_link'] ); 2693 2694 echo $args['cancel_reply_after']; 2695 } 2696 2697 echo $args['title_reply_after']; 2698 2699 if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) : 2700 2701 echo $args['must_log_in']; 2702 /** 2703 * Fires after the HTML-formatted 'must log in after' message in the comment form. 2704 * 2705 * @since 3.0.0 2706 */ 2707 do_action( 'comment_form_must_log_in_after' ); 2708 2709 else : 2710 2711 printf( 2712 '<form action="%s" method="post" id="%s" class="%s"%s>', 2713 esc_url( $args['action'] ), 2714 esc_attr( $args['id_form'] ), 2715 esc_attr( $args['class_form'] ), 2716 ( $html5 ? ' novalidate' : '' ) 2717 ); 2718 2719 /** 2720 * Fires at the top of the comment form, inside the form tag. 2721 * 2722 * @since 3.0.0 2723 */ 2724 do_action( 'comment_form_top' ); 2725 2726 if ( is_user_logged_in() ) : 2727 2728 /** 2729 * Filters the 'logged in' message for the comment form for display. 2730 * 2731 * @since 3.0.0 2732 * 2733 * @param string $args_logged_in The HTML for the 'logged in as [user]' message, 2734 * the Edit profile link, and the Log out link. 2735 * @param array $commenter An array containing the comment author's 2736 * username, email, and URL. 2737 * @param string $user_identity If the commenter is a registered user, 2738 * the display name, blank otherwise. 2739 */ 2740 echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity ); 2741 2742 /** 2743 * Fires after the is_user_logged_in() check in the comment form. 2744 * 2745 * @since 3.0.0 2746 * 2747 * @param array $commenter An array containing the comment author's 2748 * username, email, and URL. 2749 * @param string $user_identity If the commenter is a registered user, 2750 * the display name, blank otherwise. 2751 */ 2752 do_action( 'comment_form_logged_in_after', $commenter, $user_identity ); 2753 2754 else : 2755 2756 echo $args['comment_notes_before']; 2757 2758 endif; 2759 2760 // Prepare an array of all fields, including the textarea. 2761 $comment_fields = array( 'comment' => $args['comment_field'] ) + (array) $args['fields']; 2762 2763 /** 2764 * Filters the comment form fields, including the textarea. 2765 * 2766 * @since 4.4.0 2767 * 2768 * @param array $comment_fields The comment fields. 2769 */ 2770 $comment_fields = apply_filters( 'comment_form_fields', $comment_fields ); 2771 2772 // Get an array of field names, excluding the textarea. 2773 $comment_field_keys = array_diff( array_keys( $comment_fields ), array( 'comment' ) ); 2774 2775 // Get the first and the last field name, excluding the textarea. 2776 $first_field = reset( $comment_field_keys ); 2777 $last_field = end( $comment_field_keys ); 2778 2779 foreach ( $comment_fields as $name => $field ) { 2780 2781 if ( 'comment' === $name ) { 2782 2783 /** 2784 * Filters the content of the comment textarea field for display. 2785 * 2786 * @since 3.0.0 2787 * 2788 * @param string $args_comment_field The content of the comment textarea field. 2789 */ 2790 echo apply_filters( 'comment_form_field_comment', $field ); 2791 2792 echo $args['comment_notes_after']; 2793 2794 } elseif ( ! is_user_logged_in() ) { 2795 2796 if ( $first_field === $name ) { 2797 /** 2798 * Fires before the comment fields in the comment form, excluding the textarea. 2799 * 2800 * @since 3.0.0 2801 */ 2802 do_action( 'comment_form_before_fields' ); 2803 } 2804 2805 /** 2806 * Filters a comment form field for display. 2807 * 2808 * The dynamic portion of the hook name, `$name`, refers to the name 2809 * of the comment form field. 2810 * 2811 * Possible hook names include: 2812 * 2813 * - `comment_form_field_comment` 2814 * - `comment_form_field_author` 2815 * - `comment_form_field_email` 2816 * - `comment_form_field_url` 2817 * - `comment_form_field_cookies` 2818 * 2819 * @since 3.0.0 2820 * 2821 * @param string $field The HTML-formatted output of the comment form field. 2822 */ 2823 echo apply_filters( "comment_form_field_{$name}", $field ) . "\n"; 2824 2825 if ( $last_field === $name ) { 2826 /** 2827 * Fires after the comment fields in the comment form, excluding the textarea. 2828 * 2829 * @since 3.0.0 2830 */ 2831 do_action( 'comment_form_after_fields' ); 2832 } 2833 } 2834 } 2835 2836 $submit_button = sprintf( 2837 $args['submit_button'], 2838 esc_attr( $args['name_submit'] ), 2839 esc_attr( $args['id_submit'] ), 2840 esc_attr( $args['class_submit'] ), 2841 esc_attr( $args['label_submit'] ) 2842 ); 2843 2844 /** 2845 * Filters the submit button for the comment form to display. 2846 * 2847 * @since 4.2.0 2848 * 2849 * @param string $submit_button HTML markup for the submit button. 2850 * @param array $args Arguments passed to comment_form(). 2851 */ 2852 $submit_button = apply_filters( 'comment_form_submit_button', $submit_button, $args ); 2853 2854 $submit_field = sprintf( 2855 $args['submit_field'], 2856 $submit_button, 2857 get_comment_id_fields( $post_id ) 2858 ); 2859 2860 /** 2861 * Filters the submit field for the comment form to display. 2862 * 2863 * The submit field includes the submit button, hidden fields for the 2864 * comment form, and any wrapper markup. 2865 * 2866 * @since 4.2.0 2867 * 2868 * @param string $submit_field HTML markup for the submit field. 2869 * @param array $args Arguments passed to comment_form(). 2870 */ 2871 echo apply_filters( 'comment_form_submit_field', $submit_field, $args ); 2872 2873 /** 2874 * Fires at the bottom of the comment form, inside the closing form tag. 2875 * 2876 * @since 1.5.0 2877 * 2878 * @param int $post_id The post ID. 2879 */ 2880 do_action( 'comment_form', $post_id ); 2881 2882 echo '</form>'; 2883 2884 endif; 2885 ?> 2886 </div><!-- #respond --> 2887 <?php 2888 2889 /** 2890 * Fires after the comment form. 2891 * 2892 * @since 3.0.0 2893 */ 2894 do_action( 'comment_form_after' ); 2895 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Fri Jul 26 08:20:01 2024 | Cross-referenced by PHPXref |