| [ 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 string|void Comment classes if `$display` is false, nothing otherwise. 492 * @phpstan-return ( $display is true ? void : string ) 493 */ 494 function comment_class( $css_class = '', $comment = null, $post = null, $display = true ) { 495 // Separates classes with a single space, collates classes for comment DIV. 496 $css_class = 'class="' . implode( ' ', get_comment_class( $css_class, $comment, $post ) ) . '"'; 497 498 if ( $display ) { 499 echo $css_class; 500 } else { 501 return $css_class; 502 } 503 } 504 505 /** 506 * Returns the classes for the comment div as an array. 507 * 508 * @since 2.7.0 509 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 510 * 511 * @global int $comment_alt 512 * @global int $comment_depth 513 * @global int $comment_thread_alt 514 * 515 * @param string|string[] $css_class Optional. One or more classes to add to the class list. 516 * Default empty. 517 * @param int|WP_Comment $comment_id Optional. Comment ID or WP_Comment object. Default current comment. 518 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. 519 * @return string[] An array of classes. 520 */ 521 function get_comment_class( $css_class = '', $comment_id = null, $post = null ) { 522 global $comment_alt, $comment_depth, $comment_thread_alt; 523 524 $classes = array(); 525 526 $comment = get_comment( $comment_id ); 527 if ( ! $comment ) { 528 return $classes; 529 } 530 531 // Get the comment type (comment, trackback). 532 $classes[] = ( empty( $comment->comment_type ) ) ? 'comment' : $comment->comment_type; 533 534 // Add classes for comment authors that are registered users. 535 $user = $comment->user_id ? get_userdata( $comment->user_id ) : false; 536 if ( $user ) { 537 $classes[] = 'byuser'; 538 $classes[] = 'comment-author-' . sanitize_html_class( $user->user_nicename, $comment->user_id ); 539 // For comment authors who are the author of the post. 540 $_post = get_post( $post ); 541 if ( $_post ) { 542 if ( $comment->user_id === $_post->post_author ) { 543 $classes[] = 'bypostauthor'; 544 } 545 } 546 } 547 548 if ( empty( $comment_alt ) ) { 549 $comment_alt = 0; 550 } 551 if ( empty( $comment_depth ) ) { 552 $comment_depth = 1; 553 } 554 if ( empty( $comment_thread_alt ) ) { 555 $comment_thread_alt = 0; 556 } 557 558 if ( $comment_alt % 2 ) { 559 $classes[] = 'odd'; 560 $classes[] = 'alt'; 561 } else { 562 $classes[] = 'even'; 563 } 564 565 ++$comment_alt; 566 567 // Alt for top-level comments. 568 if ( 1 === $comment_depth ) { 569 if ( $comment_thread_alt % 2 ) { 570 $classes[] = 'thread-odd'; 571 $classes[] = 'thread-alt'; 572 } else { 573 $classes[] = 'thread-even'; 574 } 575 ++$comment_thread_alt; 576 } 577 578 $classes[] = "depth-$comment_depth"; 579 580 if ( ! empty( $css_class ) ) { 581 if ( ! is_array( $css_class ) ) { 582 $css_class = preg_split( '#\s+#', $css_class ); 583 } 584 $classes = array_merge( $classes, $css_class ); 585 } 586 587 $classes = array_map( 'esc_attr', $classes ); 588 589 /** 590 * Filters the returned CSS classes for the current comment. 591 * 592 * @since 2.7.0 593 * 594 * @param string[] $classes An array of comment classes. 595 * @param string[] $css_class An array of additional classes added to the list. 596 * @param string $comment_id The comment ID as a numeric string. 597 * @param WP_Comment $comment The comment object. 598 * @param int|WP_Post $post The post ID or WP_Post object. 599 */ 600 return apply_filters( 'comment_class', $classes, $css_class, $comment->comment_ID, $comment, $post ); 601 } 602 603 /** 604 * Retrieves the comment date of the current comment. 605 * 606 * @since 1.5.0 607 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 608 * 609 * @param string $format Optional. PHP date format. Defaults to the 'date_format' option. 610 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to get the date. 611 * Default current comment. 612 * @return string The comment's date. 613 */ 614 function get_comment_date( $format = '', $comment_id = 0 ) { 615 $comment = get_comment( $comment_id ); 616 617 $_format = ! empty( $format ) ? $format : get_option( 'date_format' ); 618 619 $comment_date = mysql2date( $_format, $comment->comment_date ); 620 621 /** 622 * Filters the returned comment date. 623 * 624 * @since 1.5.0 625 * 626 * @param string|int $comment_date Formatted date string or Unix timestamp. 627 * @param string $format PHP date format. 628 * @param WP_Comment $comment The comment object. 629 */ 630 return apply_filters( 'get_comment_date', $comment_date, $format, $comment ); 631 } 632 633 /** 634 * Displays the comment date of the current comment. 635 * 636 * @since 0.71 637 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 638 * 639 * @param string $format Optional. PHP date format. Defaults to the 'date_format' option. 640 * @param int|WP_Comment $comment_id WP_Comment or ID of the comment for which to print the date. 641 * Default current comment. 642 */ 643 function comment_date( $format = '', $comment_id = 0 ) { 644 echo get_comment_date( $format, $comment_id ); 645 } 646 647 /** 648 * Retrieves the excerpt of the given comment. 649 * 650 * Returns a maximum of 20 words with an ellipsis appended if necessary. 651 * 652 * @since 1.5.0 653 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 654 * 655 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to get the excerpt. 656 * Default current comment. 657 * @return string The possibly truncated comment excerpt. 658 */ 659 function get_comment_excerpt( $comment_id = 0 ) { 660 $comment = get_comment( $comment_id ); 661 662 if ( ! post_password_required( $comment->comment_post_ID ) ) { 663 $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) ); 664 } else { 665 $comment_text = __( 'Password protected' ); 666 } 667 668 /* translators: Maximum number of words used in a comment excerpt. */ 669 $comment_excerpt_length = (int) _x( '20', 'comment_excerpt_length' ); 670 671 /** 672 * Filters the maximum number of words used in the comment excerpt. 673 * 674 * @since 4.4.0 675 * 676 * @param int $comment_excerpt_length The amount of words you want to display in the comment excerpt. 677 */ 678 $comment_excerpt_length = apply_filters( 'comment_excerpt_length', $comment_excerpt_length ); 679 680 $comment_excerpt = wp_trim_words( $comment_text, $comment_excerpt_length, '…' ); 681 682 /** 683 * Filters the retrieved comment excerpt. 684 * 685 * @since 1.5.0 686 * @since 4.1.0 The `$comment_id` and `$comment` parameters were added. 687 * 688 * @param string $comment_excerpt The comment excerpt text. 689 * @param string $comment_id The comment ID as a numeric string. 690 * @param WP_Comment $comment The comment object. 691 */ 692 return apply_filters( 'get_comment_excerpt', $comment_excerpt, $comment->comment_ID, $comment ); 693 } 694 695 /** 696 * Displays the excerpt of the current comment. 697 * 698 * @since 1.2.0 699 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object. 700 * 701 * @param int|WP_Comment $comment_id Optional. WP_Comment or ID of the comment for which to print the excerpt. 702 * Default current comment. 703 */ 704 function comment_excerpt( $comment_id = 0 ) { 705 $comment = get_comment( $comment_id ); 706 707 $comment_excerpt = get_comment_excerpt( $comment ); 708 709 /** 710 * Filters the comment excerpt for display. 711 * 712 * @since 1.2.0 713 * @since 4.1.0 The `$comment_id` parameter was added. 714 * 715 * @param string $comment_excerpt The comment excerpt text. 716 * @param string $comment_id The comment ID as a numeric string. 717 */ 718 echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment->comment_ID ); 719 } 720 721 /** 722 * Retrieves the comment ID of the current comment. 723 * 724 * @since 1.5.0 725 * 726 * @return string The comment ID as a numeric string. 727 */ 728 function get_comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid 729 $comment = get_comment(); 730 731 $comment_id = ! empty( $comment->comment_ID ) ? $comment->comment_ID : '0'; 732 733 /** 734 * Filters the returned comment ID. 735 * 736 * @since 1.5.0 737 * @since 4.1.0 The `$comment` parameter was added. 738 * 739 * @param string $comment_id The current comment ID as a numeric string. 740 * @param WP_Comment $comment The comment object. 741 */ 742 return apply_filters( 'get_comment_ID', $comment_id, $comment ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase 743 } 744 745 /** 746 * Displays the comment ID of the current comment. 747 * 748 * @since 0.71 749 */ 750 function comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid 751 echo get_comment_ID(); 752 } 753 754 /** 755 * Retrieves the link to a given comment. 756 * 757 * @since 1.5.0 758 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. Added `$cpage` argument. 759 * 760 * @see get_page_of_comment() 761 * 762 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 763 * @global bool $in_comment_loop 764 * 765 * @param WP_Comment|int|null $comment Optional. Comment to retrieve. Default current comment. 766 * @param array $args { 767 * An array of optional arguments to override the defaults. 768 * 769 * @type string $type Passed to get_page_of_comment(). 770 * @type int $page Current page of comments, for calculating comment pagination. 771 * @type int $per_page Per-page value for comment pagination. 772 * @type int $max_depth Passed to get_page_of_comment(). 773 * @type int|string $cpage Value to use for the comment's "comment-page" or "cpage" value. 774 * If provided, this value overrides any value calculated from `$page` 775 * and `$per_page`. 776 * } 777 * @return string The permalink to the given comment. 778 */ 779 function get_comment_link( $comment = null, $args = array() ) { 780 global $wp_rewrite, $in_comment_loop; 781 782 $comment = get_comment( $comment ); 783 784 // Back-compat. 785 if ( ! is_array( $args ) ) { 786 $args = array( 'page' => $args ); 787 } 788 789 $defaults = array( 790 'type' => 'all', 791 'page' => '', 792 'per_page' => '', 793 'max_depth' => '', 794 'cpage' => null, 795 ); 796 797 $args = wp_parse_args( $args, $defaults ); 798 799 $comment_link = get_permalink( $comment->comment_post_ID ); 800 801 // The 'cpage' param takes precedence. 802 if ( ! is_null( $args['cpage'] ) ) { 803 $cpage = $args['cpage']; 804 805 // No 'cpage' is provided, so we calculate one. 806 } else { 807 if ( '' === $args['per_page'] && get_option( 'page_comments' ) ) { 808 $args['per_page'] = get_option( 'comments_per_page' ); 809 } 810 811 if ( empty( $args['per_page'] ) ) { 812 $args['per_page'] = 0; 813 $args['page'] = 0; 814 } 815 816 $cpage = $args['page']; 817 818 if ( '' === $cpage ) { 819 if ( ! empty( $in_comment_loop ) ) { 820 $cpage = (int) get_query_var( 'cpage' ); 821 } else { 822 // Requires a database hit, so we only do it when we can't figure out from context. 823 $cpage = get_page_of_comment( $comment->comment_ID, $args ); 824 } 825 } 826 827 /* 828 * If the default page displays the oldest comments, the permalinks for comments on the default page 829 * do not need a 'cpage' query var. 830 */ 831 if ( 'oldest' === get_option( 'default_comments_page' ) && 1 === $cpage ) { 832 $cpage = ''; 833 } 834 } 835 836 if ( $cpage && get_option( 'page_comments' ) ) { 837 if ( $wp_rewrite->using_permalinks() ) { 838 $comment_link = trailingslashit( $comment_link ) . $wp_rewrite->comments_pagination_base . '-' . $cpage; 839 } else { 840 $comment_link = add_query_arg( 'cpage', $cpage, $comment_link ); 841 } 842 } 843 844 if ( $wp_rewrite->using_permalinks() ) { 845 $comment_link = user_trailingslashit( $comment_link, 'comment' ); 846 } 847 848 $comment_link = $comment_link . '#comment-' . $comment->comment_ID; 849 850 /** 851 * Filters the returned single comment permalink. 852 * 853 * @since 2.8.0 854 * @since 4.4.0 Added the `$cpage` parameter. 855 * 856 * @see get_page_of_comment() 857 * 858 * @param string $comment_link The comment permalink with '#comment-$id' appended. 859 * @param WP_Comment $comment The current comment object. 860 * @param array $args An array of arguments to override the defaults. 861 * @param int $cpage The calculated 'cpage' value. 862 */ 863 return apply_filters( 'get_comment_link', $comment_link, $comment, $args, $cpage ); 864 } 865 866 /** 867 * Retrieves the link to the current post comments. 868 * 869 * @since 1.5.0 870 * 871 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 872 * @return string The link to the comments. 873 */ 874 function get_comments_link( $post = 0 ) { 875 $hash = get_comments_number( $post ) ? '#comments' : '#respond'; 876 $comments_link = get_permalink( $post ) . $hash; 877 878 /** 879 * Filters the returned post comments permalink. 880 * 881 * @since 3.6.0 882 * 883 * @param string $comments_link Post comments permalink with '#comments' appended. 884 * @param int|WP_Post $post Post ID or WP_Post object. 885 */ 886 return apply_filters( 'get_comments_link', $comments_link, $post ); 887 } 888 889 /** 890 * Displays the link to the current post comments. 891 * 892 * @since 0.71 893 * 894 * @param string $deprecated Not Used. 895 * @param string $deprecated_2 Not Used. 896 * 897 * @phpstan-param '' $deprecated 898 * @phpstan-param '' $deprecated_2 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|false $zero Optional. Text for no comments. Default false. 958 * @param string|false $one Optional. Text for one comment. Default false. 959 * @param string|false $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 = (int) 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 $comment_text Optional. String to display for comment type. Default false. 1188 * @param string|false $trackback_text Optional. String to display for trackback type. Default false. 1189 * @param string|false $pingback_text Optional. String to display for pingback type. Default false. 1190 */ 1191 function comment_type( $comment_text = false, $trackback_text = false, $pingback_text = false ) { 1192 if ( false === $comment_text ) { 1193 $comment_text = _x( 'Comment', 'noun' ); 1194 } 1195 if ( false === $trackback_text ) { 1196 $trackback_text = __( 'Trackback' ); 1197 } 1198 if ( false === $pingback_text ) { 1199 $pingback_text = __( 'Pingback' ); 1200 } 1201 $type = get_comment_type(); 1202 switch ( $type ) { 1203 case 'trackback': 1204 echo $trackback_text; 1205 break; 1206 case 'pingback': 1207 echo $pingback_text; 1208 break; 1209 default: 1210 echo $comment_text; 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 * @since 2.5.0 Deprecated the `$deprecated_echo` argument. 1247 * 1248 * @see get_trackback_url() 1249 * 1250 * @param true $deprecated_echo Deprecated. Use {@see get_trackback_url()}. Echo the URL or 1251 * return it. Default true. 1252 * @return string|void The trackback URL when `$deprecated_echo` is false, nothing otherwise. 1253 * @phpstan-return ( $deprecated_echo is true ? void : string ) 1254 * 1255 * @phpstan-ignore conditionalType.alwaysTrue (Typed `true` to flag the deprecated argument.) 1256 */ 1257 function trackback_url( $deprecated_echo = true ) { 1258 if ( true !== $deprecated_echo ) { 1259 _deprecated_argument( 1260 __FUNCTION__, 1261 '2.5.0', 1262 sprintf( 1263 /* translators: %s: get_trackback_url() */ 1264 __( 'Use %s instead if you do not want the value echoed.' ), 1265 '<code>get_trackback_url()</code>' 1266 ) 1267 ); 1268 } 1269 1270 if ( $deprecated_echo ) { 1271 echo get_trackback_url(); 1272 } else { 1273 return get_trackback_url(); 1274 } 1275 } 1276 1277 /** 1278 * Generates and displays the RDF for the trackback information of current post. 1279 * 1280 * Deprecated in 3.0.0, and restored in 3.0.1. 1281 * 1282 * @since 0.71 1283 * 1284 * @param int|string $deprecated Not used (Was $timezone = 0). 1285 * 1286 * @phpstan-param '' $deprecated 1287 */ 1288 function trackback_rdf( $deprecated = '' ) { 1289 if ( ! empty( $deprecated ) ) { 1290 _deprecated_argument( __FUNCTION__, '2.5.0' ); 1291 } 1292 1293 if ( isset( $_SERVER['HTTP_USER_AGENT'] ) && false !== stripos( $_SERVER['HTTP_USER_AGENT'], 'W3C_Validator' ) ) { 1294 return; 1295 } 1296 1297 echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" 1298 xmlns:dc="http://purl.org/dc/elements/1.1/" 1299 xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/"> 1300 <rdf:Description rdf:about="'; 1301 the_permalink(); 1302 echo '"' . "\n"; 1303 echo ' dc:identifier="'; 1304 the_permalink(); 1305 echo '"' . "\n"; 1306 echo ' dc:title="' . str_replace( '--', '--', wptexturize( strip_tags( get_the_title() ) ) ) . '"' . "\n"; 1307 echo ' trackback:ping="' . get_trackback_url() . '"' . " />\n"; 1308 echo '</rdf:RDF>'; 1309 } 1310 1311 /** 1312 * Determines whether the current post is open for comments. 1313 * 1314 * For more information on this and similar theme functions, check out 1315 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1316 * Conditional Tags} article in the Theme Developer Handbook. 1317 * 1318 * @since 1.5.0 1319 * 1320 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. 1321 * @return bool True if the comments are open. 1322 */ 1323 function comments_open( $post = null ) { 1324 $_post = get_post( $post ); 1325 1326 $post_id = $_post ? $_post->ID : 0; 1327 $comments_open = ( $_post && ( 'open' === $_post->comment_status ) ); 1328 1329 /** 1330 * Filters whether the current post is open for comments. 1331 * 1332 * @since 2.5.0 1333 * 1334 * @param bool $comments_open Whether the current post is open for comments. 1335 * @param int $post_id The post ID. 1336 */ 1337 return apply_filters( 'comments_open', $comments_open, $post_id ); 1338 } 1339 1340 /** 1341 * Determines whether the current post is open for pings. 1342 * 1343 * For more information on this and similar theme functions, check out 1344 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 1345 * Conditional Tags} article in the Theme Developer Handbook. 1346 * 1347 * @since 1.5.0 1348 * 1349 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. 1350 * @return bool True if pings are accepted 1351 */ 1352 function pings_open( $post = null ) { 1353 $_post = get_post( $post ); 1354 1355 $post_id = $_post ? $_post->ID : 0; 1356 $pings_open = ( $_post && ( 'open' === $_post->ping_status ) ); 1357 1358 /** 1359 * Filters whether the current post is open for pings. 1360 * 1361 * @since 2.5.0 1362 * 1363 * @param bool $pings_open Whether the current post is open for pings. 1364 * @param int $post_id The post ID. 1365 */ 1366 return apply_filters( 'pings_open', $pings_open, $post_id ); 1367 } 1368 1369 /** 1370 * Displays form token for unfiltered comments. 1371 * 1372 * Will only display nonce token if the current user has permissions for 1373 * unfiltered html. Won't display the token for other users. 1374 * 1375 * The function was backported to 2.0.10 and was added to versions 2.1.3 and 1376 * above. Does not exist in versions prior to 2.0.10 in the 2.0 branch and in 1377 * the 2.1 branch, prior to 2.1.3. Technically added in 2.2.0. 1378 * 1379 * Backported to 2.0.10. 1380 * 1381 * @since 2.1.3 1382 */ 1383 function wp_comment_form_unfiltered_html_nonce() { 1384 $post = get_post(); 1385 $post_id = $post ? $post->ID : 0; 1386 1387 if ( current_user_can( 'unfiltered_html' ) ) { 1388 wp_nonce_field( 'unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment_disabled', false ); 1389 wp_print_inline_script_tag( "(function(){if(window===window.parent){document.getElementById('_wp_unfiltered_html_comment_disabled').name='_wp_unfiltered_html_comment';}})();\n//# sourceURL=" . rawurlencode( __FUNCTION__ ) ); 1390 } 1391 } 1392 1393 /** 1394 * Loads the comment template specified in $file. 1395 * 1396 * Will not display the comments template if not on single post or page, or if 1397 * the post does not have comments. 1398 * 1399 * Uses the WordPress database object to query for the comments. The comments 1400 * are passed through the {@see 'comments_array'} filter hook with the list of comments 1401 * and the post ID respectively. 1402 * 1403 * The `$file` path is passed through a filter hook called {@see 'comments_template'}, 1404 * which includes the template directory and $file combined. Tries the $filtered path 1405 * first and if it fails it will require the default comment template from the 1406 * default theme. If either does not exist, then the WordPress process will be 1407 * halted. It is advised for that reason, that the default theme is not deleted. 1408 * 1409 * Will not try to get the comments if the post has none. 1410 * 1411 * @since 1.5.0 1412 * 1413 * @global WP_Query $wp_query WordPress Query object. 1414 * @global WP_Post $post Global post object. 1415 * @global wpdb $wpdb WordPress database abstraction object. 1416 * @global int $id 1417 * @global WP_Comment $comment Global comment object. 1418 * @global string $user_login 1419 * @global string $user_identity 1420 * @global bool $overridden_cpage 1421 * @global bool $withcomments 1422 * @global string $wp_stylesheet_path Path to current theme's stylesheet directory. 1423 * @global string $wp_template_path Path to current theme's template directory. 1424 * 1425 * @param string $file Optional. The file to load. Default '/comments.php'. 1426 * @param bool $separate_comments Optional. Whether to separate the comments by comment type. 1427 * Default false. 1428 */ 1429 function comments_template( $file = '/comments.php', $separate_comments = false ) { 1430 global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_identity, $overridden_cpage, $wp_stylesheet_path, $wp_template_path; 1431 1432 if ( ! ( is_single() || is_page() || $withcomments ) || empty( $post ) ) { 1433 return; 1434 } 1435 1436 if ( empty( $file ) ) { 1437 $file = '/comments.php'; 1438 } 1439 1440 $req = get_option( 'require_name_email' ); 1441 1442 /* 1443 * Comment author information fetched from the comment cookies. 1444 */ 1445 $commenter = wp_get_current_commenter(); 1446 1447 /* 1448 * The name of the current comment author escaped for use in attributes. 1449 * Escaped by sanitize_comment_cookies(). 1450 */ 1451 $comment_author = $commenter['comment_author']; 1452 1453 /* 1454 * The email address of the current comment author escaped for use in attributes. 1455 * Escaped by sanitize_comment_cookies(). 1456 */ 1457 $comment_author_email = $commenter['comment_author_email']; 1458 1459 /* 1460 * The URL of the current comment author escaped for use in attributes. 1461 */ 1462 $comment_author_url = esc_url( $commenter['comment_author_url'] ); 1463 1464 $comment_args = array( 1465 'orderby' => 'comment_date_gmt', 1466 'order' => 'ASC', 1467 'status' => 'approve', 1468 'post_id' => $post->ID, 1469 'no_found_rows' => false, 1470 ); 1471 1472 if ( get_option( 'thread_comments' ) ) { 1473 $comment_args['hierarchical'] = 'threaded'; 1474 } else { 1475 $comment_args['hierarchical'] = false; 1476 } 1477 1478 if ( is_user_logged_in() ) { 1479 $comment_args['include_unapproved'] = array( get_current_user_id() ); 1480 } else { 1481 $unapproved_email = wp_get_unapproved_comment_author_email(); 1482 1483 if ( $unapproved_email ) { 1484 $comment_args['include_unapproved'] = array( $unapproved_email ); 1485 } 1486 } 1487 1488 $per_page = 0; 1489 if ( get_option( 'page_comments' ) ) { 1490 $per_page = (int) get_query_var( 'comments_per_page' ); 1491 if ( 0 === $per_page ) { 1492 $per_page = (int) get_option( 'comments_per_page' ); 1493 } 1494 1495 $comment_args['number'] = $per_page; 1496 $page = (int) get_query_var( 'cpage' ); 1497 1498 if ( $page ) { 1499 $comment_args['offset'] = ( $page - 1 ) * $per_page; 1500 } elseif ( 'oldest' === get_option( 'default_comments_page' ) ) { 1501 $comment_args['offset'] = 0; 1502 } else { 1503 // If fetching the first page of 'newest', we need a top-level comment count. 1504 $top_level_query = new WP_Comment_Query(); 1505 $top_level_args = array( 1506 'count' => true, 1507 'orderby' => false, 1508 'post_id' => $post->ID, 1509 'status' => 'approve', 1510 ); 1511 1512 if ( $comment_args['hierarchical'] ) { 1513 $top_level_args['parent'] = 0; 1514 } 1515 1516 if ( isset( $comment_args['include_unapproved'] ) ) { 1517 $top_level_args['include_unapproved'] = $comment_args['include_unapproved']; 1518 } 1519 1520 /** 1521 * Filters the arguments used in the top level comments query. 1522 * 1523 * @since 5.6.0 1524 * 1525 * @see WP_Comment_Query::__construct() 1526 * 1527 * @param array $top_level_args { 1528 * The top level query arguments for the comments template. 1529 * 1530 * @type bool $count Whether to return a comment count. 1531 * @type string|array $orderby The field(s) to order by. 1532 * @type int $post_id The post ID. 1533 * @type string|array $status The comment status to limit results by. 1534 * } 1535 */ 1536 $top_level_args = apply_filters( 'comments_template_top_level_query_args', $top_level_args ); 1537 1538 $top_level_count = $top_level_query->query( $top_level_args ); 1539 1540 $comment_args['offset'] = ( (int) ceil( $top_level_count / $per_page ) - 1 ) * $per_page; 1541 } 1542 } 1543 1544 /** 1545 * Filters the arguments used to query comments in comments_template(). 1546 * 1547 * @since 4.5.0 1548 * 1549 * @see WP_Comment_Query::__construct() 1550 * 1551 * @param array $comment_args { 1552 * Array of WP_Comment_Query arguments. 1553 * 1554 * @type string|array $orderby Field(s) to order by. 1555 * @type string $order Order of results. Accepts 'ASC' or 'DESC'. 1556 * @type string $status Comment status. 1557 * @type array $include_unapproved Array of IDs or email addresses whose unapproved comments 1558 * will be included in results. 1559 * @type int $post_id ID of the post. 1560 * @type bool $no_found_rows Whether to refrain from querying for found rows. 1561 * @type bool $update_comment_meta_cache Whether to prime cache for comment meta. 1562 * @type bool|string $hierarchical Whether to query for comments hierarchically. 1563 * @type int $offset Comment offset. 1564 * @type int $number Number of comments to fetch. 1565 * } 1566 */ 1567 $comment_args = apply_filters( 'comments_template_query_args', $comment_args ); 1568 1569 $comment_query = new WP_Comment_Query( $comment_args ); 1570 $_comments = $comment_query->comments; 1571 1572 // Trees must be flattened before they're passed to the walker. 1573 if ( $comment_args['hierarchical'] ) { 1574 $comments_flat = array(); 1575 foreach ( $_comments as $_comment ) { 1576 $comments_flat[] = $_comment; 1577 $comment_children = $_comment->get_children( 1578 array( 1579 'format' => 'flat', 1580 'status' => $comment_args['status'], 1581 'orderby' => $comment_args['orderby'], 1582 ) 1583 ); 1584 1585 foreach ( $comment_children as $comment_child ) { 1586 $comments_flat[] = $comment_child; 1587 } 1588 } 1589 } else { 1590 $comments_flat = $_comments; 1591 } 1592 1593 /** 1594 * Filters the comments array. 1595 * 1596 * @since 2.1.0 1597 * 1598 * @param array $comments Array of comments supplied to the comments template. 1599 * @param int $post_id Post ID. 1600 */ 1601 $wp_query->comments = apply_filters( 'comments_array', $comments_flat, $post->ID ); 1602 1603 $comments = &$wp_query->comments; 1604 $wp_query->comment_count = count( $wp_query->comments ); 1605 $wp_query->max_num_comment_pages = $comment_query->max_num_pages; 1606 1607 if ( $separate_comments ) { 1608 $wp_query->comments_by_type = separate_comments( $comments ); 1609 $comments_by_type = &$wp_query->comments_by_type; 1610 } else { 1611 $wp_query->comments_by_type = array(); 1612 } 1613 1614 $overridden_cpage = false; 1615 1616 if ( '' === get_query_var( 'cpage' ) && $wp_query->max_num_comment_pages > 1 ) { 1617 set_query_var( 'cpage', 'newest' === get_option( 'default_comments_page' ) ? get_comment_pages_count() : 1 ); 1618 $overridden_cpage = true; 1619 } 1620 1621 if ( ! defined( 'COMMENTS_TEMPLATE' ) ) { 1622 define( 'COMMENTS_TEMPLATE', true ); 1623 } 1624 1625 $theme_template = trailingslashit( $wp_stylesheet_path ) . $file; 1626 1627 /** 1628 * Filters the path to the theme template file used for the comments template. 1629 * 1630 * @since 1.5.1 1631 * 1632 * @param string $theme_template The path to the theme template file. 1633 */ 1634 $include = apply_filters( 'comments_template', $theme_template ); 1635 1636 if ( file_exists( $include ) ) { 1637 require $include; 1638 } elseif ( file_exists( trailingslashit( $wp_template_path ) . $file ) ) { 1639 require trailingslashit( $wp_template_path ) . $file; 1640 } else { // Backward compat code will be removed in a future release. 1641 require ABSPATH . WPINC . '/theme-compat/comments.php'; 1642 } 1643 } 1644 1645 /** 1646 * Displays the link to the comments for the current post ID. 1647 * 1648 * @since 0.71 1649 * 1650 * @param false|string $zero Optional. String to display when no comments. Default false. 1651 * @param false|string $one Optional. String to display when only one comment is available. Default false. 1652 * @param false|string $more Optional. String to display when there are more than one comment. Default false. 1653 * @param string $css_class Optional. CSS class to use for comments. Default empty. 1654 * @param false|string $none Optional. String to display when comments have been turned off. Default false. 1655 */ 1656 function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) { 1657 $post_id = get_the_ID(); 1658 $post_title = get_the_title(); 1659 $comments_number = (int) get_comments_number( $post_id ); 1660 1661 if ( false === $zero ) { 1662 /* translators: %s: Post title. */ 1663 $zero = sprintf( __( 'No Comments<span class="screen-reader-text"> on %s</span>' ), $post_title ); 1664 } 1665 1666 if ( false === $one ) { 1667 /* translators: %s: Post title. */ 1668 $one = sprintf( __( '1 Comment<span class="screen-reader-text"> on %s</span>' ), $post_title ); 1669 } 1670 1671 if ( false === $more ) { 1672 /* translators: 1: Number of comments, 2: Post title. */ 1673 $more = _n( 1674 '%1$s Comment<span class="screen-reader-text"> on %2$s</span>', 1675 '%1$s Comments<span class="screen-reader-text"> on %2$s</span>', 1676 $comments_number 1677 ); 1678 $more = sprintf( $more, number_format_i18n( $comments_number ), $post_title ); 1679 } 1680 1681 if ( false === $none ) { 1682 /* translators: %s: Post title. */ 1683 $none = sprintf( __( 'Comments Off<span class="screen-reader-text"> on %s</span>' ), $post_title ); 1684 } 1685 1686 if ( 0 === $comments_number && ! comments_open() && ! pings_open() ) { 1687 printf( 1688 '<span%1$s>%2$s</span>', 1689 ! empty( $css_class ) ? ' class="' . esc_attr( $css_class ) . '"' : '', 1690 $none 1691 ); 1692 return; 1693 } 1694 1695 if ( post_password_required() ) { 1696 _e( 'Enter your password to view comments.' ); 1697 return; 1698 } 1699 1700 if ( 0 === $comments_number ) { 1701 $respond_link = get_permalink() . '#respond'; 1702 /** 1703 * Filters the respond link when a post has no comments. 1704 * 1705 * @since 4.4.0 1706 * 1707 * @param string $respond_link The default response link. 1708 * @param int $post_id The post ID. 1709 */ 1710 $comments_link = apply_filters( 'respond_link', $respond_link, $post_id ); 1711 } else { 1712 $comments_link = get_comments_link(); 1713 } 1714 1715 $link_attributes = ''; 1716 1717 /** 1718 * Filters the comments link attributes for display. 1719 * 1720 * @since 2.5.0 1721 * 1722 * @param string $link_attributes The comments link attributes. Default empty. 1723 */ 1724 $link_attributes = apply_filters( 'comments_popup_link_attributes', $link_attributes ); 1725 1726 printf( 1727 '<a href="%1$s"%2$s%3$s>%4$s</a>', 1728 esc_url( $comments_link ), 1729 ! empty( $css_class ) ? ' class="' . $css_class . '" ' : '', 1730 $link_attributes, 1731 get_comments_number_text( $zero, $one, $more ) 1732 ); 1733 } 1734 1735 /** 1736 * Retrieves HTML content for reply to comment link. 1737 * 1738 * @since 2.7.0 1739 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. 1740 * 1741 * @param array $args { 1742 * Optional. Override default arguments. 1743 * 1744 * @type string $add_below The first part of the selector used to identify the comment to respond below. 1745 * The resulting value is passed as the first parameter to addComment.moveForm(), 1746 * concatenated as $add_below-$comment->comment_ID. Default 'comment'. 1747 * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter 1748 * to addComment.moveForm(), and appended to the link URL as a hash value. 1749 * Default 'respond'. 1750 * @type string $reply_text The visible text of the Reply link. Default 'Reply'. 1751 * @type string $reply_to_text The accessible name of the Reply link, using `%s` as a placeholder 1752 * for the comment author's name. Default 'Reply to %s'. 1753 * Should start with the visible `reply_text` value. 1754 * @type bool $show_reply_to_text Whether to use `reply_to_text` as visible link text. Default false. 1755 * @type string $login_text The text of the link to reply if logged out. Default 'Log in to Reply'. 1756 * @type int $max_depth The max depth of the comment tree. Default 0. 1757 * @type int $depth The depth of the new comment. Must be greater than 0 and less than the value 1758 * of the 'thread_comments_depth' option set in Settings > Discussion. Default 0. 1759 * @type string $before The text or HTML to add before the reply link. Default empty. 1760 * @type string $after The text or HTML to add after the reply link. Default empty. 1761 * } 1762 * @param int|WP_Comment $comment Optional. Comment being replied to. Default current comment. 1763 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. 1764 * Default current post. 1765 * @return string|false|null Link to show comment form on success. False if comments are closed. Null on failure. 1766 */ 1767 function get_comment_reply_link( $args = array(), $comment = null, $post = null ) { 1768 $defaults = array( 1769 'add_below' => 'comment', 1770 'respond_id' => 'respond', 1771 /* translators: Comment reply button text. */ 1772 'reply_text' => _x( 'Reply', 'verb' ), 1773 /* translators: Comment reply button text. %s: Comment author name. */ 1774 'reply_to_text' => __( 'Reply to %s' ), 1775 'login_text' => __( 'Log in to Reply' ), 1776 'max_depth' => 0, 1777 'depth' => 0, 1778 'before' => '', 1779 'after' => '', 1780 'show_reply_to_text' => false, 1781 ); 1782 1783 $args = wp_parse_args( $args, $defaults ); 1784 1785 $args['max_depth'] = (int) $args['max_depth']; 1786 $args['depth'] = (int) $args['depth']; 1787 1788 if ( 0 === $args['depth'] || $args['max_depth'] <= $args['depth'] ) { 1789 return null; 1790 } 1791 1792 $comment = get_comment( $comment ); 1793 1794 if ( empty( $comment ) ) { 1795 return null; 1796 } 1797 1798 if ( empty( $post ) ) { 1799 $post = $comment->comment_post_ID; 1800 } 1801 1802 $post = get_post( $post ); 1803 1804 if ( ! comments_open( $post->ID ) ) { 1805 return false; 1806 } 1807 1808 if ( get_option( 'page_comments' ) ) { 1809 $permalink = str_replace( '#comment-' . $comment->comment_ID, '', get_comment_link( $comment ) ); 1810 } else { 1811 $permalink = get_permalink( $post->ID ); 1812 } 1813 1814 /** 1815 * Filters the comment reply link arguments. 1816 * 1817 * @since 4.1.0 1818 * 1819 * @param array $args Comment reply link arguments. See get_comment_reply_link() 1820 * for more information on accepted arguments. 1821 * @param WP_Comment $comment The object of the comment being replied to. 1822 * @param WP_Post $post The WP_Post object. 1823 */ 1824 $args = apply_filters( 'comment_reply_link_args', $args, $comment, $post ); 1825 1826 if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) { 1827 $link = sprintf( 1828 '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>', 1829 esc_url( wp_login_url( get_permalink() ) ), 1830 $args['login_text'] 1831 ); 1832 } else { 1833 $data_attributes = array( 1834 'commentid' => $comment->comment_ID, 1835 'postid' => $post->ID, 1836 'belowelement' => $args['add_below'] . '-' . $comment->comment_ID, 1837 'respondelement' => $args['respond_id'], 1838 'replyto' => sprintf( $args['reply_to_text'], get_comment_author( $comment ) ), 1839 ); 1840 1841 $data_attribute_string = ''; 1842 1843 foreach ( $data_attributes as $name => $value ) { 1844 $data_attribute_string .= " data-{$name}=\"" . esc_attr( $value ) . '"'; 1845 } 1846 1847 $data_attribute_string = trim( $data_attribute_string ); 1848 1849 $reply_text = $args['show_reply_to_text'] 1850 ? sprintf( $args['reply_to_text'], get_comment_author( $comment ) ) 1851 : $args['reply_text']; 1852 1853 $aria_label = $args['show_reply_to_text'] ? '' : sprintf( $args['reply_to_text'], get_comment_author( $comment ) ); 1854 1855 $link = sprintf( 1856 '<a rel="nofollow" class="comment-reply-link" href="%s" %s%s>%s</a>', 1857 esc_url( 1858 add_query_arg( 1859 array( 1860 'replytocom' => $comment->comment_ID, 1861 'unapproved' => false, 1862 'moderation-hash' => false, 1863 ), 1864 $permalink 1865 ) 1866 ) . '#' . $args['respond_id'], 1867 $data_attribute_string, 1868 $aria_label ? ' aria-label="' . esc_attr( $aria_label ) . '"' : '', 1869 $reply_text 1870 ); 1871 } 1872 1873 $comment_reply_link = $args['before'] . $link . $args['after']; 1874 1875 /** 1876 * Filters the comment reply link. 1877 * 1878 * @since 2.7.0 1879 * 1880 * @param string $comment_reply_link The HTML markup for the comment reply link. 1881 * @param array $args An array of arguments overriding the defaults. 1882 * @param WP_Comment $comment The object of the comment being replied. 1883 * @param WP_Post $post The WP_Post object. 1884 */ 1885 return apply_filters( 'comment_reply_link', $comment_reply_link, $args, $comment, $post ); 1886 } 1887 1888 /** 1889 * Displays the HTML content for reply to comment link. 1890 * 1891 * @since 2.7.0 1892 * 1893 * @see get_comment_reply_link() 1894 * 1895 * @param array $args Optional. Override default options. Default empty array. 1896 * @param int|WP_Comment $comment Optional. Comment being replied to. Default current comment. 1897 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. 1898 * Default current post. 1899 */ 1900 function comment_reply_link( $args = array(), $comment = null, $post = null ) { 1901 echo get_comment_reply_link( $args, $comment, $post ); 1902 } 1903 1904 /** 1905 * Retrieves HTML content for reply to post link. 1906 * 1907 * @since 2.7.0 1908 * 1909 * @param array $args { 1910 * Optional. Override default arguments. 1911 * 1912 * @type string $add_below The first part of the selector used to identify the comment to respond below. 1913 * The resulting value is passed as the first parameter to addComment.moveForm(), 1914 * concatenated as $add_below-$comment->comment_ID. Default is 'post'. 1915 * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter 1916 * to addComment.moveForm(), and appended to the link URL as a hash value. 1917 * Default 'respond'. 1918 * @type string $reply_text Text of the Reply link. Default is 'Leave a Comment'. 1919 * @type string $login_text Text of the link to reply if logged out. Default is 'Log in to leave a Comment'. 1920 * @type string $before Text or HTML to add before the reply link. Default empty. 1921 * @type string $after Text or HTML to add after the reply link. Default empty. 1922 * } 1923 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. 1924 * Default current post. 1925 * @return string|false Link to show comment form on success. False if comments are closed. 1926 */ 1927 function get_post_reply_link( $args = array(), $post = null ) { 1928 $defaults = array( 1929 'add_below' => 'post', 1930 'respond_id' => 'respond', 1931 'reply_text' => __( 'Leave a Comment' ), 1932 'login_text' => __( 'Log in to leave a Comment' ), 1933 'before' => '', 1934 'after' => '', 1935 ); 1936 1937 $args = wp_parse_args( $args, $defaults ); 1938 1939 $post = get_post( $post ); 1940 1941 if ( ! comments_open( $post->ID ) ) { 1942 return false; 1943 } 1944 1945 if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) { 1946 $link = sprintf( 1947 '<a rel="nofollow" class="comment-reply-login" href="%s">%s</a>', 1948 wp_login_url( get_permalink() ), 1949 $args['login_text'] 1950 ); 1951 } else { 1952 $onclick = sprintf( 1953 'return addComment.moveForm( "%1$s-%2$s", "0", "%3$s", "%2$s" )', 1954 $args['add_below'], 1955 $post->ID, 1956 $args['respond_id'] 1957 ); 1958 1959 $link = sprintf( 1960 "<a rel='nofollow' class='comment-reply-link' href='%s' onclick='%s'>%s</a>", 1961 get_permalink( $post->ID ) . '#' . $args['respond_id'], 1962 $onclick, 1963 $args['reply_text'] 1964 ); 1965 } 1966 1967 $post_reply_link = $args['before'] . $link . $args['after']; 1968 1969 /** 1970 * Filters the formatted post comments link HTML. 1971 * 1972 * @since 2.7.0 1973 * 1974 * @param string $post_reply_link The HTML-formatted post comments link. 1975 * @param int|WP_Post $post The post ID or WP_Post object. 1976 */ 1977 return apply_filters( 'post_comments_link', $post_reply_link, $post ); 1978 } 1979 1980 /** 1981 * Displays the HTML content for reply to post link. 1982 * 1983 * @since 2.7.0 1984 * 1985 * @see get_post_reply_link() 1986 * 1987 * @param array $args Optional. Override default options. Default empty array. 1988 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. 1989 * Default current post. 1990 */ 1991 function post_reply_link( $args = array(), $post = null ) { 1992 echo get_post_reply_link( $args, $post ); 1993 } 1994 1995 /** 1996 * Retrieves HTML content for cancel comment reply link. 1997 * 1998 * @since 2.7.0 1999 * @since 6.2.0 Added the `$post` parameter. 2000 * 2001 * @param string $link_text Optional. Text to display for cancel reply link. If empty, 2002 * defaults to 'Click here to cancel reply'. Default empty. 2003 * @param int|WP_Post|null $post Optional. The post the comment thread is being 2004 * displayed for. Defaults to the current global post. 2005 * @return string 2006 */ 2007 function get_cancel_comment_reply_link( $link_text = '', $post = null ) { 2008 if ( empty( $link_text ) ) { 2009 $link_text = __( 'Click here to cancel reply.' ); 2010 } 2011 2012 $post = get_post( $post ); 2013 $reply_to_id = $post ? _get_comment_reply_id( $post->ID ) : 0; 2014 $link_style = 0 !== $reply_to_id ? '' : ' style="display:none;"'; 2015 $link_url = esc_url( remove_query_arg( array( 'replytocom', 'unapproved', 'moderation-hash' ) ) ) . '#respond'; 2016 2017 $cancel_comment_reply_link = sprintf( 2018 '<a rel="nofollow" id="cancel-comment-reply-link" href="%1$s"%2$s>%3$s</a>', 2019 $link_url, 2020 $link_style, 2021 $link_text 2022 ); 2023 2024 /** 2025 * Filters the cancel comment reply link HTML. 2026 * 2027 * @since 2.7.0 2028 * 2029 * @param string $cancel_comment_reply_link The HTML-formatted cancel comment reply link. 2030 * @param string $link_url Cancel comment reply link URL. 2031 * @param string $link_text Cancel comment reply link text. 2032 */ 2033 return apply_filters( 'cancel_comment_reply_link', $cancel_comment_reply_link, $link_url, $link_text ); 2034 } 2035 2036 /** 2037 * Displays HTML content for cancel comment reply link. 2038 * 2039 * @since 2.7.0 2040 * 2041 * @param string $link_text Optional. Text to display for cancel reply link. If empty, 2042 * defaults to 'Click here to cancel reply'. Default empty. 2043 */ 2044 function cancel_comment_reply_link( $link_text = '' ) { 2045 echo get_cancel_comment_reply_link( $link_text ); 2046 } 2047 2048 /** 2049 * Retrieves hidden input HTML for replying to comments. 2050 * 2051 * @since 3.0.0 2052 * @since 6.2.0 Renamed `$post_id` to `$post` and added WP_Post support. 2053 * 2054 * @param int|WP_Post|null $post Optional. The post the comment is being displayed for. 2055 * Defaults to the current global post. 2056 * @return string Hidden input HTML for replying to comments. 2057 */ 2058 function get_comment_id_fields( $post = null ) { 2059 $post = get_post( $post ); 2060 if ( ! $post ) { 2061 return ''; 2062 } 2063 2064 $post_id = $post->ID; 2065 $reply_to_id = _get_comment_reply_id( $post_id ); 2066 2067 $comment_id_fields = "<input type='hidden' name='comment_post_ID' value='$post_id' id='comment_post_ID' />\n"; 2068 $comment_id_fields .= "<input type='hidden' name='comment_parent' id='comment_parent' value='$reply_to_id' />\n"; 2069 2070 /** 2071 * Filters the returned comment ID fields. 2072 * 2073 * @since 3.0.0 2074 * 2075 * @param string $comment_id_fields The HTML-formatted hidden ID field comment elements. 2076 * @param int $post_id The post ID. 2077 * @param int $reply_to_id The ID of the comment being replied to. 2078 */ 2079 return apply_filters( 'comment_id_fields', $comment_id_fields, $post_id, $reply_to_id ); 2080 } 2081 2082 /** 2083 * Outputs hidden input HTML for replying to comments. 2084 * 2085 * Adds two hidden inputs to the comment form to identify the `comment_post_ID` 2086 * and `comment_parent` values for threaded comments. 2087 * 2088 * This tag must be within the `<form>` section of the `comments.php` template. 2089 * 2090 * @since 2.7.0 2091 * @since 6.2.0 Renamed `$post_id` to `$post` and added WP_Post support. 2092 * 2093 * @see get_comment_id_fields() 2094 * 2095 * @param int|WP_Post|null $post Optional. The post the comment is being displayed for. 2096 * Defaults to the current global post. 2097 */ 2098 function comment_id_fields( $post = null ) { 2099 echo get_comment_id_fields( $post ); 2100 } 2101 2102 /** 2103 * Displays text based on comment reply status. 2104 * 2105 * Only affects users with JavaScript disabled. 2106 * 2107 * {@internal The $comment global must be present to allow template tags access to the current 2108 * comment. See https://core.trac.wordpress.org/changeset/36512.} 2109 * 2110 * @since 2.7.0 2111 * @since 6.2.0 Added the `$post` parameter. 2112 * 2113 * @global WP_Comment $comment Global comment object. 2114 * 2115 * @param string|false $no_reply_text Optional. Text to display when not replying to a comment. 2116 * Default false. 2117 * @param string|false $reply_text Optional. Text to display when replying to a comment. 2118 * Default false. Accepts "%s" for the author of the comment 2119 * being replied to. 2120 * @param bool $link_to_parent Optional. Boolean to control making the author's name a link 2121 * to their comment. Default true. 2122 * @param int|WP_Post|null $post Optional. The post that the comment form is being displayed for. 2123 * Defaults to the current global post. 2124 */ 2125 function comment_form_title( $no_reply_text = false, $reply_text = false, $link_to_parent = true, $post = null ) { 2126 global $comment; 2127 2128 if ( false === $no_reply_text ) { 2129 $no_reply_text = __( 'Leave a Reply' ); 2130 } 2131 2132 if ( false === $reply_text ) { 2133 /* translators: %s: Author of the comment being replied to. */ 2134 $reply_text = __( 'Leave a Reply to %s' ); 2135 } 2136 2137 $post = get_post( $post ); 2138 if ( ! $post ) { 2139 echo $no_reply_text; 2140 return; 2141 } 2142 2143 $reply_to_id = _get_comment_reply_id( $post->ID ); 2144 2145 if ( 0 === $reply_to_id ) { 2146 echo $no_reply_text; 2147 return; 2148 } 2149 2150 // Sets the global so that template tags can be used in the comment form. 2151 $comment = get_comment( $reply_to_id ); 2152 2153 if ( $link_to_parent ) { 2154 $comment_author = sprintf( 2155 '<a href="#comment-%1$s">%2$s</a>', 2156 get_comment_ID(), 2157 get_comment_author( $reply_to_id ) 2158 ); 2159 } else { 2160 $comment_author = get_comment_author( $reply_to_id ); 2161 } 2162 2163 printf( $reply_text, $comment_author ); 2164 } 2165 2166 /** 2167 * Gets the comment's reply to ID from the $_GET['replytocom']. 2168 * 2169 * @since 6.2.0 2170 * 2171 * @access private 2172 * 2173 * @param int|WP_Post|null $post The post the comment is being displayed for. 2174 * Defaults to the current global post. 2175 * @return int Comment's reply to ID. 2176 */ 2177 function _get_comment_reply_id( $post = null ) { 2178 $post = get_post( $post ); 2179 2180 if ( ! $post || ! isset( $_GET['replytocom'] ) || ! is_numeric( $_GET['replytocom'] ) ) { 2181 return 0; 2182 } 2183 2184 $reply_to_id = (int) $_GET['replytocom']; 2185 2186 /* 2187 * Validate the comment. 2188 * Bail out if it does not exist, is not approved, or its 2189 * `comment_post_ID` does not match the given post ID. 2190 */ 2191 $comment = get_comment( $reply_to_id ); 2192 2193 if ( 2194 ! $comment instanceof WP_Comment || 2195 0 === (int) $comment->comment_approved || 2196 $post->ID !== (int) $comment->comment_post_ID 2197 ) { 2198 return 0; 2199 } 2200 2201 return $reply_to_id; 2202 } 2203 2204 /** 2205 * Displays a list of comments. 2206 * 2207 * Used in the comments.php template to list comments for a particular post. 2208 * 2209 * @since 2.7.0 2210 * 2211 * @see WP_Query::$comments 2212 * 2213 * @global WP_Query $wp_query WordPress Query object. 2214 * @global int $comment_alt 2215 * @global int $comment_depth 2216 * @global int $comment_thread_alt 2217 * @global bool $overridden_cpage 2218 * @global bool $in_comment_loop 2219 * 2220 * @param string|array $args { 2221 * Optional. Formatting options. 2222 * 2223 * @type object $walker Instance of a Walker class to list comments. Default null. 2224 * @type int $max_depth The maximum comments depth. Default empty. 2225 * @type string $style The style of list ordering. Accepts 'ul', 'ol', or 'div'. 2226 * 'div' will result in no additional list markup. Default 'ul'. 2227 * @type callable $callback Callback function to use. Default null. 2228 * @type callable $end-callback Callback function to use at the end. Default null. 2229 * @type string $type Type of comments to list. Accepts 'all', 'comment', 2230 * 'pingback', 'trackback', 'pings'. Default 'all'. 2231 * @type int $page Page ID to list comments for. Default empty. 2232 * @type int $per_page Number of comments to list per page. Default empty. 2233 * @type int $avatar_size Height and width dimensions of the avatar size. Default 32. 2234 * @type bool $reverse_top_level Ordering of the listed comments. If true, will display 2235 * newest comments first. Default null. 2236 * @type bool $reverse_children Whether to reverse child comments in the list. Default null. 2237 * @type string $format How to format the comments list. Accepts 'html5', 'xhtml'. 2238 * Default 'html5' if the theme supports it. 2239 * @type bool $short_ping Whether to output short pings. Default false. 2240 * @type bool $echo Whether to echo the output or return it. Default true. 2241 * } 2242 * @param WP_Comment[] $comments Optional. Array of WP_Comment objects. Default null. 2243 * @return string|null|void HTML list of comments when 'echo' is false, null when there are 2244 * no comments to list. Nothing otherwise. 2245 * @phpstan-return ( 2246 * $args is array{ echo: false|0|''|'0', ... } 2247 * ? string|null 2248 * : ( $args is ''|'0'|array ? void : string|null ) 2249 * ) 2250 */ 2251 function wp_list_comments( $args = array(), $comments = null ) { 2252 global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop; 2253 2254 $in_comment_loop = true; 2255 2256 $comment_alt = 0; 2257 $comment_thread_alt = 0; 2258 $comment_depth = 1; 2259 2260 $defaults = array( 2261 'walker' => null, 2262 'max_depth' => '', 2263 'style' => 'ul', 2264 'callback' => null, 2265 'end-callback' => null, 2266 'type' => 'all', 2267 'page' => '', 2268 'per_page' => '', 2269 'avatar_size' => 32, 2270 'reverse_top_level' => null, 2271 'reverse_children' => '', 2272 'format' => current_theme_supports( 'html5', 'comment-list' ) ? 'html5' : 'xhtml', 2273 'short_ping' => false, 2274 'echo' => true, 2275 ); 2276 2277 $parsed_args = wp_parse_args( $args, $defaults ); 2278 2279 /** 2280 * Filters the arguments used in retrieving the comment list. 2281 * 2282 * @since 4.0.0 2283 * 2284 * @see wp_list_comments() 2285 * 2286 * @param array $parsed_args An array of arguments for displaying comments. 2287 */ 2288 $parsed_args = apply_filters( 'wp_list_comments_args', $parsed_args ); 2289 2290 // Figure out what comments we'll be looping through ($_comments). 2291 if ( null !== $comments ) { 2292 $comments = (array) $comments; 2293 if ( empty( $comments ) ) { 2294 return null; 2295 } 2296 if ( 'all' !== $parsed_args['type'] ) { 2297 $comments_by_type = separate_comments( $comments ); 2298 if ( empty( $comments_by_type[ $parsed_args['type'] ] ) ) { 2299 return null; 2300 } 2301 $_comments = $comments_by_type[ $parsed_args['type'] ]; 2302 } else { 2303 $_comments = $comments; 2304 } 2305 } else { 2306 /* 2307 * If 'page' or 'per_page' has been passed, and does not match what's in $wp_query, 2308 * perform a separate comment query and allow Walker_Comment to paginate. 2309 */ 2310 if ( $parsed_args['page'] || $parsed_args['per_page'] ) { 2311 $current_cpage = (int) get_query_var( 'cpage' ); 2312 if ( ! $current_cpage ) { 2313 $current_cpage = 'newest' === get_option( 'default_comments_page' ) ? 1 : $wp_query->max_num_comment_pages; 2314 } 2315 2316 $current_per_page = (int) get_query_var( 'comments_per_page' ); 2317 if ( (int) $parsed_args['page'] !== $current_cpage || (int) $parsed_args['per_page'] !== $current_per_page ) { 2318 $comment_args = array( 2319 'post_id' => get_the_ID(), 2320 'orderby' => 'comment_date_gmt', 2321 'order' => 'ASC', 2322 'status' => 'approve', 2323 ); 2324 2325 if ( is_user_logged_in() ) { 2326 $comment_args['include_unapproved'] = array( get_current_user_id() ); 2327 } else { 2328 $unapproved_email = wp_get_unapproved_comment_author_email(); 2329 2330 if ( $unapproved_email ) { 2331 $comment_args['include_unapproved'] = array( $unapproved_email ); 2332 } 2333 } 2334 2335 $comments = get_comments( $comment_args ); 2336 2337 if ( 'all' !== $parsed_args['type'] ) { 2338 $comments_by_type = separate_comments( $comments ); 2339 if ( empty( $comments_by_type[ $parsed_args['type'] ] ) ) { 2340 return null; 2341 } 2342 2343 $_comments = $comments_by_type[ $parsed_args['type'] ]; 2344 } else { 2345 $_comments = $comments; 2346 } 2347 } 2348 2349 // Otherwise, fall back on the comments from `$wp_query->comments`. 2350 } else { 2351 if ( empty( $wp_query->comments ) ) { 2352 return null; 2353 } 2354 if ( 'all' !== $parsed_args['type'] ) { 2355 if ( empty( $wp_query->comments_by_type ) ) { 2356 $wp_query->comments_by_type = separate_comments( $wp_query->comments ); 2357 } 2358 if ( empty( $wp_query->comments_by_type[ $parsed_args['type'] ] ) ) { 2359 return null; 2360 } 2361 $_comments = $wp_query->comments_by_type[ $parsed_args['type'] ]; 2362 } else { 2363 $_comments = $wp_query->comments; 2364 } 2365 2366 if ( $wp_query->max_num_comment_pages ) { 2367 $default_comments_page = get_option( 'default_comments_page' ); 2368 $cpage = (int) get_query_var( 'cpage' ); 2369 2370 if ( 'newest' === $default_comments_page ) { 2371 $parsed_args['cpage'] = $cpage; 2372 } elseif ( 1 === $cpage ) { 2373 /* 2374 * When the first page shows the oldest comments, 2375 * post permalink is the same as the comment permalink. 2376 */ 2377 $parsed_args['cpage'] = ''; 2378 } else { 2379 $parsed_args['cpage'] = $cpage; 2380 } 2381 2382 $parsed_args['page'] = 0; 2383 $parsed_args['per_page'] = 0; 2384 } 2385 } 2386 } 2387 2388 if ( '' === $parsed_args['per_page'] && get_option( 'page_comments' ) ) { 2389 $parsed_args['per_page'] = get_query_var( 'comments_per_page' ); 2390 } 2391 2392 if ( empty( $parsed_args['per_page'] ) ) { 2393 $parsed_args['per_page'] = 0; 2394 $parsed_args['page'] = 0; 2395 } 2396 2397 if ( '' === $parsed_args['max_depth'] ) { 2398 if ( get_option( 'thread_comments' ) ) { 2399 $parsed_args['max_depth'] = get_option( 'thread_comments_depth' ); 2400 } else { 2401 $parsed_args['max_depth'] = -1; 2402 } 2403 } 2404 2405 if ( '' === $parsed_args['page'] ) { 2406 if ( empty( $overridden_cpage ) ) { 2407 $parsed_args['page'] = get_query_var( 'cpage' ); 2408 } else { 2409 $threaded = ( -1 !== (int) $parsed_args['max_depth'] ); 2410 $parsed_args['page'] = ( 'newest' === get_option( 'default_comments_page' ) ) ? get_comment_pages_count( $_comments, $parsed_args['per_page'], $threaded ) : 1; 2411 set_query_var( 'cpage', $parsed_args['page'] ); 2412 } 2413 } 2414 2415 // Validation check. 2416 $parsed_args['page'] = (int) $parsed_args['page']; 2417 $parsed_args['per_page'] = (int) $parsed_args['per_page']; 2418 if ( 0 === $parsed_args['page'] && 0 !== $parsed_args['per_page'] ) { 2419 $parsed_args['page'] = 1; 2420 } 2421 2422 if ( null === $parsed_args['reverse_top_level'] ) { 2423 $parsed_args['reverse_top_level'] = ( 'desc' === get_option( 'comment_order' ) ); 2424 } 2425 2426 if ( empty( $parsed_args['walker'] ) ) { 2427 $walker = new Walker_Comment(); 2428 } else { 2429 $walker = $parsed_args['walker']; 2430 } 2431 2432 $output = $walker->paged_walk( $_comments, $parsed_args['max_depth'], $parsed_args['page'], $parsed_args['per_page'], $parsed_args ); 2433 2434 $in_comment_loop = false; 2435 2436 if ( $parsed_args['echo'] ) { 2437 echo $output; 2438 } else { 2439 return $output; 2440 } 2441 } 2442 2443 /** 2444 * Outputs a complete commenting form for use within a template. 2445 * 2446 * Most strings and form fields may be controlled through the `$args` array passed 2447 * into the function, while you may also choose to use the {@see 'comment_form_default_fields'} 2448 * filter to modify the array of default fields if you'd just like to add a new 2449 * one or remove a single field. All fields are also individually passed through 2450 * a filter of the {@see 'comment_form_field_$name'} where `$name` is the key used 2451 * in the array of fields. 2452 * 2453 * @since 3.0.0 2454 * @since 4.1.0 Introduced the 'class_submit' argument. 2455 * @since 4.2.0 Introduced the 'submit_button' and 'submit_fields' arguments. 2456 * @since 4.4.0 Introduced the 'class_form', 'title_reply_before', 'title_reply_after', 2457 * 'cancel_reply_before', and 'cancel_reply_after' arguments. 2458 * @since 4.5.0 The 'author', 'email', and 'url' form fields are limited to 245, 100, 2459 * and 200 characters, respectively. 2460 * @since 4.6.0 Introduced the 'action' argument. 2461 * @since 4.9.6 Introduced the 'cookies' default comment field. 2462 * @since 5.5.0 Introduced the 'class_container' argument. 2463 * @since 6.8.2 Introduced the 'novalidate' argument. 2464 * 2465 * @param array $args { 2466 * Optional. Default arguments and form fields to override. 2467 * 2468 * @type array $fields { 2469 * Default comment fields, filterable by default via the {@see 'comment_form_default_fields'} hook. 2470 * 2471 * @type string $author Comment author field HTML. 2472 * @type string $email Comment author email field HTML. 2473 * @type string $url Comment author URL field HTML. 2474 * @type string $cookies Comment cookie opt-in field HTML. 2475 * } 2476 * @type string $comment_field The comment textarea field HTML. 2477 * @type string $must_log_in HTML element for a 'must be logged in to comment' message. 2478 * @type string $logged_in_as The HTML for the 'logged in as [user]' message, the Edit profile link, 2479 * and the Log out link. 2480 * @type string $comment_notes_before HTML element for a message displayed before the comment fields 2481 * if the user is not logged in. 2482 * Default 'Your email address will not be published.'. 2483 * @type string $comment_notes_after HTML element for a message displayed after the textarea field. 2484 * @type string $action The comment form element action attribute. Default '/wp-comments-post.php'. 2485 * @type bool $novalidate Whether the novalidate attribute is added to the comment form. Default false. 2486 * @type string $id_form The comment form element id attribute. Default 'commentform'. 2487 * @type string $id_submit The comment submit element id attribute. Default 'submit'. 2488 * @type string $class_container The comment form container class attribute. Default 'comment-respond'. 2489 * @type string $class_form The comment form element class attribute. Default 'comment-form'. 2490 * @type string $class_submit The comment submit element class attribute. Default 'submit'. 2491 * @type string $name_submit The comment submit element name attribute. Default 'submit'. 2492 * @type string $title_reply The translatable 'reply' button label. Default 'Leave a Reply'. 2493 * @type string $title_reply_to The translatable 'reply-to' button label. Default 'Leave a Reply to %s', 2494 * where %s is the author of the comment being replied to. 2495 * @type string $title_reply_before HTML displayed before the comment form title. 2496 * Default: '<h3 id="reply-title" class="comment-reply-title">'. 2497 * @type string $title_reply_after HTML displayed after the comment form title. 2498 * Default: '</h3>'. 2499 * @type string $cancel_reply_before HTML displayed before the cancel reply link. 2500 * @type string $cancel_reply_after HTML displayed after the cancel reply link. 2501 * @type string $cancel_reply_link The translatable 'cancel reply' button label. Default 'Cancel reply'. 2502 * @type string $label_submit The translatable 'submit' button label. Default 'Post a comment'. 2503 * @type string $submit_button HTML format for the Submit button. 2504 * Default: '<input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />'. 2505 * @type string $submit_field HTML format for the markup surrounding the Submit button and comment hidden 2506 * fields. Default: '<p class="form-submit">%1$s %2$s</p>', where %1$s is the 2507 * submit button markup and %2$s is the comment hidden fields. 2508 * @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'. 2509 * } 2510 * @param int|WP_Post $post Optional. Post ID or WP_Post object to generate the form for. Default current post. 2511 */ 2512 function comment_form( $args = array(), $post = null ) { 2513 $post = get_post( $post ); 2514 2515 // Exit the function if the post is invalid or comments are closed. 2516 if ( ! $post || ! comments_open( $post ) ) { 2517 /** 2518 * Fires after the comment form if comments are closed. 2519 * 2520 * For backward compatibility, this action also fires if comment_form() 2521 * is called with an invalid post object or ID. 2522 * 2523 * @since 3.0.0 2524 */ 2525 do_action( 'comment_form_comments_closed' ); 2526 2527 return; 2528 } 2529 2530 $post_id = $post->ID; 2531 $commenter = wp_get_current_commenter(); 2532 $user = wp_get_current_user(); 2533 $user_identity = $user->exists() ? $user->display_name : ''; 2534 2535 $args = wp_parse_args( $args ); 2536 if ( ! isset( $args['format'] ) ) { 2537 $args['format'] = current_theme_supports( 'html5', 'comment-form' ) ? 'html5' : 'xhtml'; 2538 } 2539 2540 $req = get_option( 'require_name_email' ); 2541 $html5 = 'html5' === $args['format']; 2542 2543 // Define attributes in HTML5 or XHTML syntax. 2544 $required_attribute = ( $html5 ? ' required' : ' required="required"' ); 2545 $checked_attribute = ( $html5 ? ' checked' : ' checked="checked"' ); 2546 2547 // Identify required fields visually and create a message about the indicator. 2548 $required_indicator = ' ' . wp_required_field_indicator(); 2549 $required_text = ' ' . wp_required_field_message(); 2550 2551 $fields = array( 2552 'author' => sprintf( 2553 '<p class="comment-form-author">%s %s</p>', 2554 sprintf( 2555 '<label for="author">%s%s</label>', 2556 __( 'Name' ), 2557 ( $req ? $required_indicator : '' ) 2558 ), 2559 sprintf( 2560 '<input id="author" name="author" type="text" value="%s" size="30" maxlength="245" autocomplete="name"%s />', 2561 esc_attr( $commenter['comment_author'] ), 2562 ( $req ? $required_attribute : '' ) 2563 ) 2564 ), 2565 'email' => sprintf( 2566 '<p class="comment-form-email">%s %s</p>', 2567 sprintf( 2568 '<label for="email">%s%s</label>', 2569 __( 'Email' ), 2570 ( $req ? $required_indicator : '' ) 2571 ), 2572 sprintf( 2573 '<input id="email" name="email" %s value="%s" size="30" maxlength="100" aria-describedby="email-notes" autocomplete="email"%s />', 2574 ( $html5 ? 'type="email"' : 'type="text"' ), 2575 esc_attr( $commenter['comment_author_email'] ), 2576 ( $req ? $required_attribute : '' ) 2577 ) 2578 ), 2579 'url' => sprintf( 2580 '<p class="comment-form-url">%s %s</p>', 2581 sprintf( 2582 '<label for="url">%s</label>', 2583 __( 'Website' ) 2584 ), 2585 sprintf( 2586 '<input id="url" name="url" %s value="%s" size="30" maxlength="200" autocomplete="url" />', 2587 ( $html5 ? 'type="url"' : 'type="text"' ), 2588 esc_attr( $commenter['comment_author_url'] ) 2589 ) 2590 ), 2591 ); 2592 2593 if ( has_action( 'set_comment_cookies', 'wp_set_comment_cookies' ) && get_option( 'show_comments_cookies_opt_in' ) ) { 2594 $consent = empty( $commenter['comment_author_email'] ) ? '' : $checked_attribute; 2595 2596 $fields['cookies'] = sprintf( 2597 '<p class="comment-form-cookies-consent">%s %s</p>', 2598 sprintf( 2599 '<input id="wp-comment-cookies-consent" name="wp-comment-cookies-consent" type="checkbox" value="yes"%s />', 2600 $consent 2601 ), 2602 sprintf( 2603 '<label for="wp-comment-cookies-consent">%s</label>', 2604 __( 'Save my name, email, and website in this browser for the next time I comment.' ) 2605 ) 2606 ); 2607 2608 // Ensure that the passed fields include cookies consent. 2609 if ( isset( $args['fields'] ) && ! isset( $args['fields']['cookies'] ) ) { 2610 $args['fields']['cookies'] = $fields['cookies']; 2611 } 2612 } 2613 2614 $original_fields = $fields; 2615 2616 /** 2617 * Filters the default comment form fields. 2618 * 2619 * @since 3.0.0 2620 * 2621 * @param string[] $fields Array of the default comment fields. 2622 */ 2623 $fields = apply_filters( 'comment_form_default_fields', $fields ); 2624 2625 $defaults = array( 2626 'fields' => $fields, 2627 'comment_field' => sprintf( 2628 '<p class="comment-form-comment">%s %s</p>', 2629 sprintf( 2630 '<label for="comment">%s%s</label>', 2631 _x( 'Comment', 'noun' ), 2632 $required_indicator 2633 ), 2634 '<textarea id="comment" name="comment" cols="45" rows="8" maxlength="65525"' . $required_attribute . '></textarea>' 2635 ), 2636 'must_log_in' => sprintf( 2637 '<p class="must-log-in">%s</p>', 2638 sprintf( 2639 /* translators: %s: Login URL. */ 2640 __( 'You must be <a href="%s">logged in</a> to post a comment.' ), 2641 /** This filter is documented in wp-includes/link-template.php */ 2642 wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) ) 2643 ) 2644 ), 2645 'logged_in_as' => sprintf( 2646 '<p class="logged-in-as">%s%s</p>', 2647 sprintf( 2648 /* translators: 1: User name, 2: Edit user link, 3: Logout URL. */ 2649 __( 'Logged in as %1$s. <a href="%2$s">Edit your profile</a>. <a href="%3$s">Log out?</a>' ), 2650 $user_identity, 2651 get_edit_user_link(), 2652 /** This filter is documented in wp-includes/link-template.php */ 2653 wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) ) 2654 ), 2655 $required_text 2656 ), 2657 'comment_notes_before' => sprintf( 2658 '<p class="comment-notes">%s%s</p>', 2659 sprintf( 2660 '<span id="email-notes">%s</span>', 2661 __( 'Your email address will not be published.' ) 2662 ), 2663 $required_text 2664 ), 2665 'comment_notes_after' => '', 2666 'action' => site_url( '/wp-comments-post.php' ), 2667 'novalidate' => false, 2668 'id_form' => 'commentform', 2669 'id_submit' => 'submit', 2670 'class_container' => 'comment-respond', 2671 'class_form' => 'comment-form', 2672 'class_submit' => 'submit', 2673 'name_submit' => 'submit', 2674 'title_reply' => __( 'Leave a Reply' ), 2675 /* translators: %s: Author of the comment being replied to. */ 2676 'title_reply_to' => __( 'Leave a Reply to %s' ), 2677 'title_reply_before' => '<h3 id="reply-title" class="comment-reply-title">', 2678 'title_reply_after' => '</h3>', 2679 'cancel_reply_before' => ' <small>', 2680 'cancel_reply_after' => '</small>', 2681 'cancel_reply_link' => __( 'Cancel reply' ), 2682 'label_submit' => __( 'Post Comment' ), 2683 'submit_button' => '<input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />', 2684 'submit_field' => '<p class="form-submit">%1$s %2$s</p>', 2685 'format' => 'xhtml', 2686 ); 2687 2688 /** 2689 * Filters the comment form default arguments. 2690 * 2691 * Use {@see 'comment_form_default_fields'} to filter the comment fields. 2692 * 2693 * @since 3.0.0 2694 * 2695 * @param array $defaults The default comment form arguments. 2696 */ 2697 $args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) ); 2698 2699 // Ensure that the filtered arguments contain all required default values. 2700 $args = array_merge( $defaults, $args ); 2701 2702 // Remove `aria-describedby` from the email field if there's no associated description. 2703 if ( isset( $args['fields']['email'] ) && ! str_contains( $args['comment_notes_before'], 'id="email-notes"' ) ) { 2704 $args['fields']['email'] = str_replace( 2705 ' aria-describedby="email-notes"', 2706 '', 2707 $args['fields']['email'] 2708 ); 2709 } 2710 2711 /** 2712 * Fires before the comment form. 2713 * 2714 * @since 3.0.0 2715 */ 2716 do_action( 'comment_form_before' ); 2717 ?> 2718 <div id="respond" class="<?php echo esc_attr( $args['class_container'] ); ?>"> 2719 <?php 2720 echo $args['title_reply_before']; 2721 2722 comment_form_title( $args['title_reply'], $args['title_reply_to'], true, $post_id ); 2723 2724 if ( get_option( 'thread_comments' ) ) { 2725 echo $args['cancel_reply_before']; 2726 2727 cancel_comment_reply_link( $args['cancel_reply_link'] ); 2728 2729 echo $args['cancel_reply_after']; 2730 } 2731 2732 echo $args['title_reply_after']; 2733 2734 if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) : 2735 2736 echo $args['must_log_in']; 2737 /** 2738 * Fires after the HTML-formatted 'must log in after' message in the comment form. 2739 * 2740 * @since 3.0.0 2741 */ 2742 do_action( 'comment_form_must_log_in_after' ); 2743 2744 else : 2745 2746 printf( 2747 '<form action="%s" method="post" id="%s" class="%s"%s>', 2748 esc_url( $args['action'] ), 2749 esc_attr( $args['id_form'] ), 2750 esc_attr( $args['class_form'] ), 2751 ( $args['novalidate'] ? ' novalidate' : '' ) 2752 ); 2753 2754 /** 2755 * Fires at the top of the comment form, inside the form tag. 2756 * 2757 * @since 3.0.0 2758 */ 2759 do_action( 'comment_form_top' ); 2760 2761 if ( is_user_logged_in() ) : 2762 2763 /** 2764 * Filters the 'logged in' message for the comment form for display. 2765 * 2766 * @since 3.0.0 2767 * 2768 * @param string $args_logged_in The HTML for the 'logged in as [user]' message, 2769 * the Edit profile link, and the Log out link. 2770 * @param array $commenter An array containing the comment author's 2771 * username, email, and URL. 2772 * @param string $user_identity If the commenter is a registered user, 2773 * the display name, blank otherwise. 2774 */ 2775 echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity ); 2776 2777 /** 2778 * Fires after the is_user_logged_in() check in the comment form. 2779 * 2780 * @since 3.0.0 2781 * 2782 * @param array $commenter An array containing the comment author's 2783 * username, email, and URL. 2784 * @param string $user_identity If the commenter is a registered user, 2785 * the display name, blank otherwise. 2786 */ 2787 do_action( 'comment_form_logged_in_after', $commenter, $user_identity ); 2788 2789 else : 2790 2791 echo $args['comment_notes_before']; 2792 2793 endif; 2794 2795 // Prepare an array of all fields, including the textarea. 2796 $comment_fields = array( 'comment' => $args['comment_field'] ) + (array) $args['fields']; 2797 2798 /** 2799 * Filters the comment form fields, including the textarea. 2800 * 2801 * @since 4.4.0 2802 * 2803 * @param array $comment_fields The comment fields. 2804 */ 2805 $comment_fields = apply_filters( 'comment_form_fields', $comment_fields ); 2806 2807 // Get an array of field names, excluding the textarea. 2808 $comment_field_keys = array_diff( array_keys( $comment_fields ), array( 'comment' ) ); 2809 2810 // Get the first and the last field name, excluding the textarea. 2811 $first_field = reset( $comment_field_keys ); 2812 $last_field = end( $comment_field_keys ); 2813 2814 foreach ( $comment_fields as $name => $field ) { 2815 2816 if ( 'comment' === $name ) { 2817 2818 /** 2819 * Filters the content of the comment textarea field for display. 2820 * 2821 * @since 3.0.0 2822 * 2823 * @param string $args_comment_field The content of the comment textarea field. 2824 */ 2825 echo apply_filters( 'comment_form_field_comment', $field ); 2826 2827 echo $args['comment_notes_after']; 2828 2829 } elseif ( ! is_user_logged_in() || ! isset( $original_fields[ $name ] ) ) { 2830 2831 if ( $first_field === $name ) { 2832 /** 2833 * Fires before the comment fields in the comment form, excluding the textarea. 2834 * 2835 * @since 3.0.0 2836 */ 2837 do_action( 'comment_form_before_fields' ); 2838 } 2839 2840 /** 2841 * Filters a comment form field for display. 2842 * 2843 * The dynamic portion of the hook name, `$name`, refers to the name 2844 * of the comment form field. 2845 * 2846 * Possible hook names include: 2847 * 2848 * - `comment_form_field_comment` 2849 * - `comment_form_field_author` 2850 * - `comment_form_field_email` 2851 * - `comment_form_field_url` 2852 * - `comment_form_field_cookies` 2853 * 2854 * @since 3.0.0 2855 * 2856 * @param string $field The HTML-formatted output of the comment form field. 2857 */ 2858 echo apply_filters( "comment_form_field_{$name}", $field ) . "\n"; 2859 2860 if ( $last_field === $name ) { 2861 /** 2862 * Fires after the comment fields in the comment form, excluding the textarea. 2863 * 2864 * @since 3.0.0 2865 */ 2866 do_action( 'comment_form_after_fields' ); 2867 } 2868 } 2869 } 2870 2871 $submit_button = sprintf( 2872 $args['submit_button'], 2873 esc_attr( $args['name_submit'] ), 2874 esc_attr( $args['id_submit'] ), 2875 esc_attr( $args['class_submit'] ), 2876 esc_attr( $args['label_submit'] ) 2877 ); 2878 2879 /** 2880 * Filters the submit button for the comment form to display. 2881 * 2882 * @since 4.2.0 2883 * 2884 * @param string $submit_button HTML markup for the submit button. 2885 * @param array $args Arguments passed to comment_form(). 2886 */ 2887 $submit_button = apply_filters( 'comment_form_submit_button', $submit_button, $args ); 2888 2889 $submit_field = sprintf( 2890 $args['submit_field'], 2891 $submit_button, 2892 get_comment_id_fields( $post_id ) 2893 ); 2894 2895 /** 2896 * Filters the submit field for the comment form to display. 2897 * 2898 * The submit field includes the submit button, hidden fields for the 2899 * comment form, and any wrapper markup. 2900 * 2901 * @since 4.2.0 2902 * 2903 * @param string $submit_field HTML markup for the submit field. 2904 * @param array $args Arguments passed to comment_form(). 2905 */ 2906 echo apply_filters( 'comment_form_submit_field', $submit_field, $args ); 2907 2908 /** 2909 * Fires at the bottom of the comment form, inside the closing form tag. 2910 * 2911 * @since 1.5.0 2912 * 2913 * @param int $post_id The post ID. 2914 */ 2915 do_action( 'comment_form', $post_id ); 2916 2917 echo '</form>'; 2918 2919 endif; 2920 ?> 2921 </div><!-- #respond --> 2922 <?php 2923 2924 /** 2925 * Fires after the comment form. 2926 * 2927 * @since 3.0.0 2928 */ 2929 do_action( 'comment_form_after' ); 2930 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Sat Oct 24 08:20:34 2026 | Cross-referenced by PHPXref |