Ticket #27083: 27083.diff
| File 27083.diff, 45.7 KB (added by , 11 years ago) |
|---|
-
src/wp-includes/comment-template.php
76 76 * 77 77 * @since 1.5.0 78 78 * 79 * @param string $comment ->comment_author_email The comment author's email address.79 * @param string $comment_author_email The comment author's email address. 80 80 */ 81 81 return apply_filters( 'get_comment_author_email', $comment->comment_author_email ); 82 82 } … … 119 119 120 120 * @since 0.71 121 121 * 122 * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty. 123 * @param string $before Optional. The text or HTML to display before the email link.Default empty. 124 * @param string $after Optional. The text or HTML to display after the email link. Default empty. 122 * @param string $linktext Optional. Text to display instead of the comment author's email address. 123 * Default empty. 124 * @param string $before Optional. Text or HTML to display before the email link.Default empty. 125 * @param string $after Optional. Text or HTML to display after the email link. Default empty. 125 126 */ 126 127 function comment_author_email_link( $linktext = '', $before = '', $after = '' ) { 127 128 if ( $link = get_comment_author_email_link( $linktext, $before, $after ) ) … … 141 142 * 142 143 * @since 2.7.0 143 144 * 144 * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty. 145 * @param string $before Optional. The text or HTML to display before the email link. Default empty. 146 * @param string $after Optional. The text or HTML to display after the email link. Default empty. 145 * @param string $linktext Optional. Text to display instead of the comment author's email address. 146 * Default empty. 147 * @param string $before Optional. Text or HTML to display before the email link. Default empty. 148 * @param string $after Optional. Text or HTML to display after the email link. Default empty. 147 149 */ 148 150 function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) { 149 151 global $comment; … … 151 153 * Filter the comment author's email for display. 152 154 * 153 155 * Care should be taken to protect the email address and assure that email 154 * harvesters do not capture your comment ors' email address.156 * harvesters do not capture your commenters' email address. 155 157 * 156 158 * @since 1.2.0 157 159 * 158 * @param string $comment ->comment_author_email The comment author's email address.160 * @param string $comment_author_email The comment author's email address. 159 161 */ 160 162 $email = apply_filters( 'comment_email', $comment->comment_author_email ); 161 163 if ((!empty($email)) && ($email != '@')) { … … 177 179 * 178 180 * @since 1.5.0 179 181 * 180 * @param int $comment_ID Optional. The ID of the comment for which to get the author's link. Default current comment. 182 * @param int $comment_ID ID of the comment for which to get the author's link. 183 * Default current comment. 181 184 * @return string The comment author name or HTML link for author's URL. 182 185 */ 183 186 function get_comment_author_link( $comment_ID = 0 ) { … … 194 197 * 195 198 * @since 1.5.0 196 199 * 197 * @param string $return The HTML-formatted comment author link. Empty for an invalid URL. 200 * @param string $return The HTML-formatted comment author link. 201 * Empty for an invalid URL. 198 202 */ 199 203 return apply_filters( 'get_comment_author_link', $return ); 200 204 } … … 203 207 * Display the html link to the url of the author of the current comment. 204 208 * 205 209 * @since 0.71 210 * 206 211 * @see get_comment_author_link() Echoes result 207 212 * 208 * @param int $comment_ID Optional. The ID of the comment for which to print the author's link. Default current comment. 213 * @param int $comment_ID ID of the comment for which to print the author's 214 * link. Default current comment. 209 215 */ 210 216 function comment_author_link( $comment_ID = 0 ) { 211 217 echo get_comment_author_link( $comment_ID ); … … 216 222 * 217 223 * @since 1.5.0 218 224 * 219 * @param int $comment_ID Optional. The ID of the comment for which to get the author's IP address. Default current comment. 220 * @return string The comment author's IP address. 225 * @param int $comment_ID ID of the comment for which to get the author's IP 226 * address. Default current comment. 227 * @return string Comment author's IP address. 221 228 */ 222 229 function get_comment_author_IP( $comment_ID = 0 ) { 223 230 $comment = get_comment( $comment_ID ); … … 227 234 * 228 235 * @since 1.5.0 229 236 * 230 * @param string $comment ->comment_author_IP The comment author's IP address.237 * @param string $comment_author_IP The comment author's IP address. 231 238 */ 232 239 return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP ); 233 240 } … … 237 244 * 238 245 * @since 0.71 239 246 * 240 * @param int $comment_ID Optional. The ID of the comment for which to print the author's IP address. Default current comment. 247 * @param int $comment_ID ID of the comment for which to print the author's IP 248 * address. Default current comment. 241 249 */ 242 250 function comment_author_IP( $comment_ID = 0 ) { 243 251 echo get_comment_author_IP( $comment_ID ); … … 248 256 * 249 257 * @since 1.5.0 250 258 * 251 * @param int $comment_ID Optional. The ID of the comment for which to get the author's URL. Default current comment. 259 * @param int $comment_ID ID of the comment for which to get the author's URL. 260 * Default current comment. 252 261 * @return string 253 262 */ 254 263 function get_comment_author_url( $comment_ID = 0 ) { … … 270 279 * 271 280 * @since 0.71 272 281 * 273 * @param int $comment_ID Optional. The ID of the comment for which to print the author's URL. Default current comment. 282 * @param int $comment_ID ID of the comment for which to print the author's URL. 283 * Default current comment. 274 284 */ 275 285 function comment_author_url( $comment_ID = 0 ) { 276 286 $author_url = get_comment_author_url( $comment_ID ); … … 296 306 * 297 307 * @since 1.5.0 298 308 * 299 * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty. 300 * @param string $before Optional. The text or HTML to display before the email link. Default empty. 301 * @param string $after Optional. The text or HTML to display after the email link. Default empty. 309 * @param string $linktext Optional. The text to display instead of the comment 310 * author's email address. Default empty. 311 * @param string $before Optional. The text or HTML to display before the email link. 312 * Default empty. 313 * @param string $after Optional. The text or HTML to display after the email link. 314 * Default empty. 302 315 * @return string The HTML link between the $before and $after parameters. 303 316 */ 304 317 function get_comment_author_url_link( $linktext = '', $before = '', $after = '' ) { … … 325 338 * 326 339 * @since 0.71 327 340 * 328 * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty. 329 * @param string $before Optional. The text or HTML to display before the email link. Default empty. 330 * @param string $after Optional. The text or HTML to display after the email link. Default empty. 341 * @param string $linktext Optional. Text to display instead of the comment author's 342 * email address. Default empty. 343 * @param string $before Optional. Text or HTML to display before the email link. 344 * Default empty. 345 * @param string $after Optional. Text or HTML to display after the email link. 346 * Default empty. 331 347 */ 332 348 function comment_author_url_link( $linktext = '', $before = '', $after = '' ) { 333 349 echo get_comment_author_url_link( $linktext, $before, $after ); 334 350 } 335 351 336 352 /** 337 * Generates semantic classes for each comment element 353 * Generates semantic classes for each comment element. 338 354 * 339 355 * @since 2.7.0 340 356 * 341 * @param string|array $class Optional. One or more classes to add to the class list. Default empty. 342 * @param int $comment_id Optional. Comment ID. Default current comment. 343 * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post. 344 * @param bool $echo Optional. Whether comment_class should echo or return. Default true. 357 * @param string|array $class Optional. One or more classes to add to the class list. 358 * Default empty. 359 * @param int $comment_id Comment ID. Default current comment. 360 * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. 361 * @param bool $echo Optional. Whether to cho or return the output. 362 * Default true. 345 363 */ 346 364 function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) { 347 365 // Separates classes with a single space, collates classes for comment DIV … … 353 371 } 354 372 355 373 /** 356 * Returns the classes for the comment div as an array 374 * Returns the classes for the comment div as an array. 357 375 * 358 376 * @since 2.7.0 359 377 * 360 378 * @param string|array $class Optional. One or more classes to add to the class list. Default empty. 361 * @param int $comment_id Optional.Comment ID. Default current comment.362 * @param int|WP_Post $post_id Optional.Post ID or WP_Post object. Default current post.379 * @param int $comment_id Comment ID. Default current comment. 380 * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. 363 381 * @return array An array of classes. 364 382 */ 365 383 function get_comment_class( $class = '', $comment_id = null, $post_id = null ) { … … 440 458 * @since 1.5.0 441 459 * 442 460 * @param string $d Optional. The format of the date. Default user's setting. 443 * @param int $comment_ID Optional. TheID of the comment for which to get the date. Default current comment.461 * @param int $comment_ID ID of the comment for which to get the date. Default current comment. 444 462 * @return string The comment's date. 445 463 */ 446 464 function get_comment_date( $d = '', $comment_ID = 0 ) { … … 466 484 * @since 0.71 467 485 * 468 486 * @param string $d Optional. The format of the date. Default user's settings. 469 * @param int $comment_ID Optional. TheID of the comment for which to print the date. Default current comment.487 * @param int $comment_ID ID of the comment for which to print the date. Default current comment. 470 488 */ 471 489 function comment_date( $d = '', $comment_ID = 0 ) { 472 490 echo get_comment_date( $d, $comment_ID ); … … 481 499 * 482 500 * @since 1.5.0 483 501 * 484 * @param int $comment_ID Optional. The ID of the comment for which to get the excerpt. Default current comment. 502 * @param int $comment_ID ID of the comment for which to get the excerpt. 503 * Default current comment. 485 504 * @return string The maybe truncated comment with 20 words or less. 486 505 */ 487 506 function get_comment_excerpt( $comment_ID = 0 ) { … … 508 527 * 509 528 * @since 1.2.0 510 529 * 511 * @param int $comment_ID Optional. The ID of the comment for which to print the excerpt. Default current comment. 530 * @param int $comment_ID ID of the comment for which to print the excerpt. 531 * Default current comment. 512 532 */ 513 533 function comment_excerpt( $comment_ID = 0 ) { 514 534 $comment_excerpt = get_comment_excerpt($comment_ID); … … 536 556 * 537 557 * @since 1.5.0 538 558 * 539 * @param int $comment ->comment_ID The current comment ID.559 * @param int $comment_ID The current comment ID. 540 560 */ 541 561 return apply_filters( 'get_comment_ID', $comment->comment_ID ); 542 562 } … … 555 575 * 556 576 * @since 1.5.0 557 577 * 558 * @param mixed $comment Optional. Comment to retrieve. Default current comment. 559 * @param array $args Optional. An array of arguments to override the defaults. @see get_page_of_comment() 578 * @see get_page_of_comment() 579 * 580 * @param mixed $comment Comment to retrieve. Default current comment. 581 * @param array $args Optional. An array of arguments to override the defaults. 560 582 * @return string The permalink to the given comment. 561 583 */ 562 584 function get_comment_link( $comment = null, $args = array() ) { … … 600 622 * 601 623 * @since 2.8.0 602 624 * 625 * @see get_page_of_comment() 626 * 603 627 * @param string $link The comment permalink with '#comment-$id' appended. 604 628 * @param object $comment The current comment object. 605 * @param array $args An array of arguments to override the defaults. @see get_page_of_comment()629 * @param array $args An array of arguments to override the defaults. 606 630 */ 607 631 return apply_filters( 'get_comment_link', $link, $comment, $args ); 608 632 } … … 612 636 * 613 637 * @since 1.5.0 614 638 * 615 * @param int|WP_Post $post_id Optional.Post ID or WP_Post object. Default current post.639 * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. 616 640 * @return string The link to the comments. 617 641 */ 618 642 function get_comments_link( $post_id = 0 ) { … … 622 646 * 623 647 * @since 624 648 * 625 * @param string $comments_link The post comments permalink with '#comments' appended.626 * @param int|WP_Post $post_id The post ID or WP_Post object.649 * @param string $comments_link Post comments permalink with '#comments' appended. 650 * @param int|WP_Post $post_id Post ID or WP_Post object. 627 651 */ 628 652 return apply_filters( 'get_comments_link', $comments_link, $post_id ); 629 653 } … … 649 673 * 650 674 * @since 1.5.0 651 675 * 652 * @param int|WP_Post $post_id Optional.Post ID or WP_Post object. Default current post.676 * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. 653 677 * @return int The number of comments a post has. 654 678 */ 655 679 function get_comments_number( $post_id = 0 ) { … … 669 693 * 670 694 * @since 1.5.0 671 695 * 672 * @param int $count Thenumber of comments a post has.673 * @param int|WP_Post $post_id The post ID or WP_Post object.696 * @param int $count Nnumber of comments a post has. 697 * @param int|WP_Post $post_id Post ID or WP_Post object. 674 698 */ 675 699 return apply_filters( 'get_comments_number', $count, $post_id ); 676 700 } … … 703 727 * 704 728 * @since 1.5.0 705 729 * 706 * @param string $output A translatable string formatted based on whether the count is equal to 0, 1, or 1+. @see _n() 730 * @see _n() 731 * 732 * @param string $output A translatable string formatted based on whether the count 733 * is equal to 0, 1, or 1+. 707 734 * @param int $number The number of post comments. 708 735 */ 709 736 echo apply_filters( 'comments_number', $output, $number ); … … 714 741 * 715 742 * @since 1.5.0 716 743 * 717 * @param int $comment_ID Optional. The ID of the comment for which to get the text. Default current comment. 718 * @param array $args Optional. An array of arguments. @see Walker_Comment::comment() 744 * @see Walker_Comment::comment() 745 * 746 * @param int $comment_ID ID of the comment for which to get the text. Default current comment. 747 * @param array $args Optional. An array of arguments. Default empty. 719 748 * @return string The comment content. 720 749 */ 721 750 function get_comment_text( $comment_ID = 0, $args = array() ) { … … 726 755 * 727 756 * @since 1.5.0 728 757 * 729 * @param string $comment->comment_content The text of the comment. 730 * @param object $comment The comment object. 731 * @param array $args An array of arguments. @see Walker_Comment::comment() 758 * @see Walker_Comment::comment() 759 * 760 * @param string $comment_content Text of the comment. 761 * @param object $comment The comment object. 762 * @param array $args An array of arguments. 732 763 */ 733 764 return apply_filters( 'get_comment_text', $comment->comment_content, $comment, $args ); 734 765 } … … 738 769 * 739 770 * @since 0.71 740 771 * 741 * @ param int $comment_ID Optional. The ID of the comment for which to print the text.742 * Default 0.743 * @param array $args Optional. An array of arguments. @see Walker_Comment::comment()744 * Default empty array.772 * @see Walker_Comment::comment() 773 * 774 * @param int $comment_ID ID of the comment for which to print the text. Default 0. 775 * @param array $args Optional. An array of arguments. Default empty array. Default empty. 745 776 */ 746 777 function comment_text( $comment_ID = 0, $args = array() ) { 747 778 $comment = get_comment( $comment_ID ); … … 752 783 * 753 784 * @since 1.2.0 754 785 * 755 * @param string $comment_text The text of the current comment. 786 * @see Walker_Comment::comment() 787 * 788 * @param string $comment_text Text of the current comment. 756 789 * @param object $comment The comment object. 757 * @param array $args An array of arguments. @see Walker_Comment::comment()790 * @param array $args An array of arguments. 758 791 */ 759 792 echo apply_filters( 'comment_text', $comment_text, $comment, $args ); 760 793 } … … 766 799 * 767 800 * @param string $d Optional. The format of the time. Default user's settings. 768 801 * @param bool $gmt Optional. Whether to use the GMT date. Default false. 769 * @param bool $translate Optional. Whether to translate the time (for use in feeds). Default true. 770 * @return string The formatted time 802 * @param bool $translate Optional. Whether to translate the time (for use in feeds). 803 * Default true. 804 * @return string The formatted time. 771 805 */ 772 806 function get_comment_time( $d = '', $gmt = false, $translate = true ) { 773 807 global $comment; … … 783 817 * @since 1.5.0 784 818 * 785 819 * @param string|int $date The comment time, formatted as a date string or Unix timestamp. 786 * @param string $d The date format.820 * @param string $d Date format. 787 821 * @param bool $gmt Whether the GMT date is in use. 788 822 * @param bool $translate Whether the time is translated. 789 823 */ … … 806 840 * 807 841 * @since 1.5.0 808 842 * 809 * @param int $comment_ID Optional. TheID of the comment for which to get the type. Default current comment.810 * @return string The comment type 843 * @param int $comment_ID ID of the comment for which to get the type. Default current comment. 844 * @return string The comment type. 811 845 */ 812 846 function get_comment_type( $comment_ID = 0 ) { 813 847 $comment = get_comment( $comment_ID ); … … 819 853 * 820 854 * @since 1.5.0 821 855 * 822 * @param string $comment ->comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.856 * @param string $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'. 823 857 */ 824 858 return apply_filters( 'get_comment_type', $comment->comment_type ); 825 859 } … … 829 863 * 830 864 * @since 0.71 831 865 * 832 * @param string $commenttxt Optional. The string to display for comment type. Default false.833 * @param string $trackbacktxt Optional. The string to display for trackback type. Default false.834 * @param string $pingbacktxt Optional. The string to display for pingback type. Default false.866 * @param string $commenttxt Optional. String to display for comment type. Default false. 867 * @param string $trackbacktxt Optional. String to display for trackback type. Default false. 868 * @param string $pingbacktxt Optional. String to display for pingback type. Default false. 835 869 */ 836 870 function comment_type( $commenttxt = false, $trackbacktxt = false, $pingbacktxt = false ) { 837 871 if ( false === $commenttxt ) $commenttxt = _x( 'Comment', 'noun' ); … … 883 917 * @since 0.71 884 918 * 885 919 * @param bool $deprecated_echo Not used. 886 * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead. 920 * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() 921 * for the result instead. 887 922 */ 888 923 function trackback_url( $deprecated_echo = true ) { 889 924 if ( $deprecated_echo !== true ) … … 929 964 * 930 965 * @since 1.5.0 931 966 * 932 * @param int|WP_Post $post_id Optional.Post ID or WP_Post object. Default current post.967 * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. 933 968 * @return bool True if the comments are open. 934 969 */ 935 970 function comments_open( $post_id = null ) { … … 954 989 * 955 990 * @since 1.5.0 956 991 * 957 * @param int|WP_Post $post_id Optional.Post ID or WP_Post object. Default current post.992 * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post. 958 993 * @return bool True if pings are accepted 959 994 */ 960 995 function pings_open( $post_id = null ) { … … 1011 1046 * @since 1.5.0 1012 1047 * 1013 1048 * @param string $file Optional. The file to load. Default '/comments.php'. 1014 * @param bool $separate_comments Optional. Whether to separate the comments by comment type. Default false. 1049 * @param bool $separate_comments Optional. Whether to separate the comments by comment type. 1050 * Default false. 1015 1051 * @return null Returns null if no comments appear. 1016 1052 */ 1017 1053 function comments_template( $file = '/comments.php', $separate_comments = false ) { … … 1025 1061 1026 1062 $req = get_option('require_name_email'); 1027 1063 1028 /* *1064 /* 1029 1065 * Comment author information fetched from the comment cookies. 1030 * 1031 * @uses wp_get_current_commenter() 1066 * Uuses wp_get_current_commenter(). 1032 1067 */ 1033 1068 $commenter = wp_get_current_commenter(); 1034 1069 1035 /* *1070 /* 1036 1071 * The name of the current comment author escaped for use in attributes. 1072 * Escaped by sanitize_comment_cookies(). 1037 1073 */ 1038 $comment_author = $commenter['comment_author']; // Escaped by sanitize_comment_cookies()1074 $comment_author = $commenter['comment_author']; 1039 1075 1040 /* *1076 /* 1041 1077 * The email address of the current comment author escaped for use in attributes. 1078 * Escaped by sanitize_comment_cookies(). 1042 1079 */ 1043 $comment_author_email = $commenter['comment_author_email']; // Escaped by sanitize_comment_cookies()1080 $comment_author_email = $commenter['comment_author_email']; 1044 1081 1045 /* *1082 /* 1046 1083 * The url of the current comment author escaped for use in attributes. 1047 1084 */ 1048 1085 $comment_author_url = esc_url($commenter['comment_author_url']); … … 1056 1093 $comments = $wpdb->get_results($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND ( comment_approved = '1' OR ( comment_author = %s AND comment_author_email = %s AND comment_approved = '0' ) ) ORDER BY comment_date_gmt", $post->ID, wp_specialchars_decode($comment_author,ENT_QUOTES), $comment_author_email)); 1057 1094 } 1058 1095 1059 // keep $comments for legacy's sake1060 1096 /** 1061 1097 * Filter the comments array. 1062 1098 * 1063 1099 * @since 2.1.0 1064 1100 * 1065 * @param array $comments The array of comments supplied to the comments template.1066 * @param int $post ->ID The post ID.1101 * @param array $comments Array of comments supplied to the comments template. 1102 * @param int $post_ID Post ID. 1067 1103 */ 1068 1104 $wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID ); 1069 1105 $comments = &$wp_query->comments; … … 1136 1172 /** 1137 1173 * Displays the link to the comments popup window for the current post ID. 1138 1174 * 1139 * Is not meant to be displayed on single posts and pages. Should be used on the1140 * lists of posts1175 * Is not meant to be displayed on single posts and pages. Should be used 1176 * on the lists of posts 1141 1177 * 1142 1178 * @global string $wpcommentspopupfile The URL to use for the popup window. 1143 1179 * @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called. 1144 1180 * 1145 1181 * @since 0.71 1146 1182 * 1147 * @param string $zero Optional. The string to display when no comments. Default false. 1148 * @param string $one Optional. The string to display when only one comment is available. Default false. 1149 * @param string $more Optional. The string to display when there are more than one comment. Default false. 1150 * @param string $css_class Optional. The CSS class to use for comments. Default empty. 1151 * @param string $none Optional. The string to display when comments have been turned off. Default false. 1183 * @param string $zero Optional. String to display when no comments. Default false. 1184 * @param string $one Optional. String to display when only one comment is available. 1185 * Default false. 1186 * @param string $more Optional. String to display when there are more than one comment. 1187 * Default false. 1188 * @param string $css_class Optional. CSS class to use for comments. Default empty. 1189 * @param string $none Optional. String to display when comments have been turned off. 1190 * Default false. 1152 1191 * @return null Returns null on single posts and pages. 1153 1192 */ 1154 1193 function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) { … … 1217 1256 * @param array $args { 1218 1257 * Optional. Override default arguments. 1219 1258 * 1220 * @type string 'add_below' The first part of the selector used to identify the comment to respond below. The resulting1221 * value is passed as the first parameter to addComment.moveForm(), concatenated1222 * as $add_below-$comment->comment_ID. Default 'comment'.1223 * @type string 'respond_id' The selector identifying the responding comment. Passed as the third parameter to addComment.moveForm(),1224 * and appended to the link URL as a hash value. Default 'respond'.1225 * @type string 'reply_text' The text of the Reply link. Default 'Reply'.1226 * @type string 'login_text' The text of the link to reply if logged out. Default 'Log in toReply'.1227 * @type int 'depth' The depth of the new comment. Must be greater than 0 and less than the value of the 'thread_comments_depth'1228 * option set in Settings > Discussion.1229 * Default 0.1230 * @type string 'before'The text or HTML to add before the reply link. Default empty.1231 * @type string 'after'The text or HTML to add after the reply link. Default empty.1259 * @type string $add_below The first part of the selector used to identify the comment to respond below. 1260 * The resulting value is passed as the first parameter to addComment.moveForm(), 1261 * concatenated as $add_below-$comment->comment_ID. Default 'comment'. 1262 * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter 1263 * to addComment.moveForm(), and appended to the link URL as a hash value. 1264 * Default 'respond'. 1265 * @type string $reply_text The text of the Reply link. Default 'Reply'. 1266 * @type string $login_text The text of the link to reply if logged out. Default 'Log in to Reply'. 1267 * @type int $depth' The depth of the new comment. Must be greater than 0 and less than the value 1268 * of the 'thread_comments_depth' option set in Settings > Discussion. Default 0. 1269 * @type string $before The text or HTML to add before the reply link. Default empty. 1270 * @type string $after The text or HTML to add after the reply link. Default empty. 1232 1271 * } 1233 * @param int $comment Optional. Comment being replied to. Default current comment. 1234 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post. 1272 * @param int $comment Comment being replied to. Default current comment. 1273 * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on. 1274 * Default current post. 1235 1275 * @return mixed Link to show comment form, if successful. False, if comments are closed. 1236 1276 */ 1237 1277 function get_comment_reply_link($args = array(), $comment = null, $post = null) { … … 1273 1313 * 1274 1314 * @since 2.7.0 1275 1315 * 1276 * @param string $before Text or HTML displayed before the reply link.1277 1316 * @param string $link The HTML markup for the comment reply link. 1278 * @param string $after Text or HTML displayed after the reply link.1279 1317 * @param array $args An array of arguments overriding the defaults. 1280 1318 * @param object $comment The object of the comment being replied. 1281 1319 * @param WP_Post $post The WP_Post object. … … 1288 1326 * 1289 1327 * @since 2.7.0 1290 1328 * 1291 * @param array $args Optional. Override default options, @see get_comment_reply_link() 1292 * @param int $comment Optional. Comment being replied to. Default current comment. 1293 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post. 1329 * @see get_comment_reply_link() 1330 * 1331 * @param array $args Optional. Override default options. 1332 * @param int $comment Comment being replied to. Default current comment. 1333 * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on. 1334 * Default current post. 1294 1335 * @return mixed Link to show comment form, if successful. False, if comments are closed. 1295 1336 */ 1296 1337 function comment_reply_link($args = array(), $comment = null, $post = null) { … … 1305 1346 * @param array $args { 1306 1347 * Optional. Override default arguments. 1307 1348 * 1308 * @type string 'add_below' The first part of the selector used to identify the comment to respond below. 1309 * The resulting value is passed as the first parameter to addComment.moveForm(), 1310 * concatenated as $add_below-$comment->comment_ID. Default is 'post'. 1311 * @type string 'respond_id' The selector identifying the responding comment. Passed as the third parameter 1312 * to addComment.moveForm(), and appended to the link URL as a hash value. Default is 'respond'. 1313 * @type string 'reply_text' The text of the Reply link. Default is 'Leave a Comment'. 1314 * @type string 'login_text' The text of the link to reply if logged out. Default is 'Log in to leave a Comment'. 1315 * @type string 'before' The text or HTML to add before the reply link. Default empty. 1316 * @type string 'after' The text or HTML to add after the reply link. Default empty. 1349 * @type string $add_below The first part of the selector used to identify the comment to respond below. 1350 * The resulting value is passed as the first parameter to addComment.moveForm(), 1351 * concatenated as $add_below-$comment->comment_ID. Default is 'post'. 1352 * @type string $respond_id The selector identifying the responding comment. Passed as the third parameter 1353 * to addComment.moveForm(), and appended to the link URL as a hash value. 1354 * Default 'respond'. 1355 * @type string $reply_text Text of the Reply link. Default is 'Leave a Comment'. 1356 * @type string $login_text Text of the link to reply if logged out. Default is 'Log in to leave a Comment'. 1357 * @type string $before Text or HTML to add before the reply link. Default empty. 1358 * @type string $after Text or HTML to add after the reply link. Default empty. 1317 1359 * } 1318 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post. 1360 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. 1361 * Default current post. 1319 1362 * @return string|bool|null Link to show comment form, if successful. False, if comments are closed. 1320 1363 */ 1321 1364 function get_post_reply_link($args = array(), $post = null) { … … 1357 1400 * 1358 1401 * @since 2.7.0 1359 1402 * 1360 * @param array $args Optional. Override default options, @see get_post_reply_link() 1361 * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post. 1403 * @see get_post_reply_link() 1404 * 1405 * @param array $args Optional. Override default options, 1406 * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on. 1407 * Default current post. 1362 1408 * @return string|bool|null Link to show comment form, if successful. False, if comments are closed. 1363 1409 */ 1364 1410 function post_reply_link($args = array(), $post = null) { … … 1386 1432 * @since 2.7.0 1387 1433 * 1388 1434 * @param string $formatted_link The HTML-formatted cancel comment reply link. 1389 * @param string $link The cancel comment reply link URL.1390 * @param string $text The cancel comment reply link text.1435 * @param string $link Cancel comment reply link URL. 1436 * @param string $text Cancel comment reply link text. 1391 1437 */ 1392 1438 return apply_filters( 'cancel_comment_reply_link', $formatted_link, $link, $text ); 1393 1439 } … … 1449 1495 * 1450 1496 * @since 2.7.0 1451 1497 * 1452 * @param string $noreplytext Optional. Text to display when not replying to a comment. Default false. 1498 * @param string $noreplytext Optional. Text to display when not replying to a comment. 1499 * Default false. 1453 1500 * @param string $replytext Optional. Text to display when replying to a comment. 1454 * Default false. Accepts "%s" for the author of the comment being replied to. 1455 * @param string $linktoparent Optional. Boolean to control making the author's name a link to their comment. Default true. 1501 * Default false. Accepts "%s" for the author of the comment 1502 * being replied to. 1503 * @param string $linktoparent Optional. Boolean to control making the author's name a link 1504 * to their comment. Default true. 1456 1505 */ 1457 1506 function comment_form_title( $noreplytext = false, $replytext = false, $linktoparent = true ) { 1458 1507 global $comment; … … 1573 1622 * 2.2 1574 1623 * 1575 1624 * @see Walker::display_element() 1625 * @see wp_list_comments() 1576 1626 * 1577 1627 * @since 2.7.0 1578 1628 * … … 1580 1630 * @param array $children_elements List of elements to continue traversing. 1581 1631 * @param int $max_depth Max depth to traverse. 1582 1632 * @param int $depth Depth of current element. 1583 * @param array $args An array of arguments. @see wp_list_comments()1633 * @param array $args An array of arguments. 1584 1634 * @param string $output Passed by reference. Used to append additional content. 1585 1635 * @return null Null on failure with no changes to parameters. 1586 1636 */ … … 1608 1658 /** 1609 1659 * Start the element output. 1610 1660 * 1661 * @since 2.7.0 1662 * 1611 1663 * @see Walker::start_el() 1664 * @see wp_list_comments() 1612 1665 * 1613 * @since 2.7.01614 *1615 1666 * @param string $output Passed by reference. Used to append additional content. 1616 1667 * @param object $comment Comment data object. 1617 1668 * @param int $depth Depth of comment in reference to parents. 1618 * @param array $args An array of arguments. @see wp_list_comments()1669 * @param array $args An array of arguments. 1619 1670 */ 1620 1671 function start_el( &$output, $comment, $depth = 0, $args = array(), $id = 0 ) { 1621 1672 $depth++; … … 1647 1698 /** 1648 1699 * Ends the element output, if needed. 1649 1700 * 1701 * @since 2.7.0 1702 * 1650 1703 * @see Walker::end_el() 1704 * @see wp_list_comments() 1651 1705 * 1652 * @since 2.7.01653 *1654 1706 * @param string $output Passed by reference. Used to append additional content. 1655 1707 * @param object $comment The comment object. Default current comment. 1656 1708 * @param int $depth Depth of comment. 1657 * @param array $args An array of arguments. @see wp_list_comments()1709 * @param array $args An array of arguments. 1658 1710 */ 1659 1711 function end_el( &$output, $comment, $depth = 0, $args = array() ) { 1660 1712 if ( !empty( $args['end-callback'] ) ) { … … 1675 1727 * @access protected 1676 1728 * @since 3.6.0 1677 1729 * 1730 * @see wp_list_comments() 1731 * 1678 1732 * @param object $comment The comment object. 1679 1733 * @param int $depth Depth of comment. 1680 * @param array $args An array of arguments. @see wp_list_comments()1734 * @param array $args An array of arguments. 1681 1735 */ 1682 1736 protected function ping( $comment, $depth, $args ) { 1683 1737 $tag = ( 'div' == $args['style'] ) ? 'div' : 'li'; … … 1695 1749 * @access protected 1696 1750 * @since 3.6.0 1697 1751 * 1752 * @see wp_list_comments() 1753 * 1698 1754 * @param object $comment Comment to display. 1699 1755 * @param int $depth Depth of comment. 1700 * @param array $args An array of arguments. @see wp_list_comments()1756 * @param array $args An array of arguments. 1701 1757 */ 1702 1758 protected function comment( $comment, $depth, $args ) { 1703 1759 if ( 'div' == $args['style'] ) { … … 1745 1801 * @access protected 1746 1802 * @since 3.6.0 1747 1803 * 1804 * @see wp_list_comments() 1805 * 1748 1806 * @param object $comment Comment to display. 1749 1807 * @param int $depth Depth of comment. 1750 * @param array $args An array of arguments. @see wp_list_comments()1808 * @param array $args An array of arguments. 1751 1809 */ 1752 1810 protected function html5_comment( $comment, $depth, $args ) { 1753 1811 $tag = ( 'div' === $args['style'] ) ? 'div' : 'li'; … … 1793 1851 * 1794 1852 * @since 2.7.0 1795 1853 * 1854 * @see WP_Query->comments 1855 * 1796 1856 * @param string|array $args { 1797 1857 * Optional. Formatting options. 1798 1858 * 1799 * @type string 'walker'The Walker class used to list comments. Default null.1800 * @type int 'max_depth'The maximum comments depth. Default empty.1801 * @type string 'style'The style of list ordering. Default 'ul'. Accepts 'ul', 'ol'.1802 * @type string 'callback'Callback function to use. Default null.1803 * @type string 'end-callback'Callback function to use at the end. Default null.1804 * @type string 'type'Type of comments to list.1805 * 1806 * @type int 'page'Page ID to list comments for. Default empty.1807 * @type int 'per_page'Number of comments to list per page. Default empty.1808 * @type int 'avatar_size'Height and width dimensions of the avatar size. Default 32.1809 * @type string 'reverse_top_level'Ordering of the listed comments. Default null. Accepts 'desc', 'asc'.1810 * @type bool 'reverse_children'Whether to reverse child comments in the list. Default null.1811 * @type string 'format'How to format the comments list.1812 * 1813 * @type bool 'short_ping'Whether to output short pings. Default false.1814 * @type bool 'echo'Whether to echo the output or return it. Default true.1859 * @type string $walker The Walker class used to list comments. Default null. 1860 * @type int $max_depth The maximum comments depth. Default empty. 1861 * @type string $style The style of list ordering. Default 'ul'. Accepts 'ul', 'ol'. 1862 * @type string $callback Callback function to use. Default null. 1863 * @type string $end-callback Callback function to use at the end. Default null. 1864 * @type string $type Type of comments to list. 1865 * Default 'all'. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'. 1866 * @type int $page Page ID to list comments for. Default empty. 1867 * @type int $per_page Number of comments to list per page. Default empty. 1868 * @type int $avatar_size Height and width dimensions of the avatar size. Default 32. 1869 * @type string $reverse_top_level Ordering of the listed comments. Default null. Accepts 'desc', 'asc'. 1870 * @type bool $reverse_children Whether to reverse child comments in the list. Default null. 1871 * @type string $format How to format the comments list. 1872 * Default 'html5' if the theme supports it. Accepts 'html5', 'xhtml'. 1873 * @type bool $short_ping Whether to output short pings. Default false. 1874 * @type bool $echo Whether to echo the output or return it. Default true. 1815 1875 * } 1816 * @param array $comments Optional. Array of comment objects. @see WP_Query->comments1876 * @param array $comments Optional. Array of comment objects. 1817 1877 */ 1818 1878 function wp_list_comments( $args = array(), $comments = null ) { 1819 1879 global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop; … … 1932 1992 * @param array $args { 1933 1993 * Optional. Default arguments and form fields to override. 1934 1994 * 1935 * @type array 'fields'{1995 * @type array $fields { 1936 1996 * Default comment fields, filterable by default via the 'comment_form_default_fields' hook. 1937 1997 * 1938 * @type string 'author' The comment author field HTML.1939 * @type string 'email' The comment author email field HTML.1940 * @type string 'url' The comment author URL field HTML.1998 * @type string $author Comment author field HTML. 1999 * @type string $email Comment author email field HTML. 2000 * @type string $url Comment author URL field HTML. 1941 2001 * } 1942 * @type string 'comment_field'The comment textarea field HTML.1943 * @type string 'must_log_in'HTML element for a 'must be logged in to comment' message.1944 * @type string 'logged_in_as'HTML element for a 'logged in as <user>' message.1945 * @type string 'comment_notes_before'HTML element for a message displayed before the comment form.1946 * 1947 * @type string 'comment_notes_after'HTML element for a message displayed after the comment form.1948 * 1949 * @type string 'id_form'The comment form element id attribute. Default 'commentform'.1950 * @type string 'id_submit'The comment submit element id attribute. Default 'submit'.1951 * @type string 'title_reply'The translatable 'reply' button label. Default 'Leave a Reply'.1952 * @type string 'title_reply_to'The translatable 'reply-to' button label. Default 'Leave a Reply to %s',1953 * 1954 * @type string 'cancel_reply_link'The translatable 'cancel reply' button label. Default 'Cancel reply'.1955 * @type string 'label_submit'The translatable 'submit' button label. Default 'Post a comment'.1956 * @type string 'format'The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.2002 * @type string $comment_field The comment textarea field HTML. 2003 * @type string $must_log_in HTML element for a 'must be logged in to comment' message. 2004 * @type string $logged_in_as HTML element for a 'logged in as <user>' message. 2005 * @type string $comment_notes_before HTML element for a message displayed before the comment form. 2006 * Default 'Your email address will not be published.'. 2007 * @type string $comment_notes_after HTML element for a message displayed after the comment form. 2008 * Default 'You may use these HTML tags and attributes ...'. 2009 * @type string $id_form The comment form element id attribute. Default 'commentform'. 2010 * @type string $id_submit The comment submit element id attribute. Default 'submit'. 2011 * @type string $title_reply The translatable 'reply' button label. Default 'Leave a Reply'. 2012 * @type string $title_reply_to The translatable 'reply-to' button label. Default 'Leave a Reply to %s', 2013 * where %s is the author of the comment being replied to. 2014 * @type string $cancel_reply_link The translatable 'cancel reply' button label. Default 'Cancel reply'. 2015 * @type string $label_submit The translatable 'submit' button label. Default 'Post a comment'. 2016 * @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'. 1957 2017 * } 1958 * @param int|WP_Post $post_id Optional.Post ID or WP_Post object to generate the form for. Default current post.2018 * @param int|WP_Post $post_id Post ID or WP_Post object to generate the form for. Default current post. 1959 2019 */ 1960 2020 function comment_form( $args = array(), $post_id = null ) { 1961 2021 if ( null === $post_id ) … … 2059 2119 * 2060 2120 * @since 3.0.0 2061 2121 * 2062 * @param string $args['logged_in_as'] The logged-in-as HTML-formatted message. 2063 * @param array $commenter An array containing the comment author's username, email, and URL. 2064 * @param string $user_identity If the commenter is a registered user, the display name, blank otherwise. 2122 * @param string $args_logged_in The logged-in-as HTML-formatted message. 2123 * @param array $commenter An array containing the comment author's 2124 * username, email, and URL. 2125 * @param string $user_identity If the commenter is a registered user, 2126 * the display name, blank otherwise. 2065 2127 */ 2066 2128 echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity ); 2067 2129 ?> … … 2071 2133 * 2072 2134 * @since 3.0.0 2073 2135 * 2074 * @param array $commenter An array containing the comment author's username, email, and URL. 2075 * @param string $user_identity If the commenter is a registered user, the display name, blank otherwise. 2136 * @param array $commenter An array containing the comment author's 2137 * username, email, and URL. 2138 * @param string $user_identity If the commenter is a registered user, 2139 * the display name, blank otherwise. 2076 2140 */ 2077 2141 do_action( 'comment_form_logged_in_after', $commenter, $user_identity ); 2078 2142 ?> … … 2112 2176 * 2113 2177 * @since 3.0.0 2114 2178 * 2115 * @param string $args ['comment_field']The content of the comment textarea field.2179 * @param string $args_comment_field The content of the comment textarea field. 2116 2180 */ 2117 2181 echo apply_filters( 'comment_form_field_comment', $args['comment_field'] ); 2118 2182 ?>