3 * Comment template functions
5 * These functions are meant to live inside of the WordPress loop.
12 * Retrieve the author of the current comment.
14 * If the comment has an empty comment_author field, then 'Anonymous' person is
18 * @uses apply_filters() Calls 'get_comment_author' hook on the comment author
20 * @return string The comment author
22 function get_comment_author() {
24 if ( empty($comment->comment_author) ) {
25 if (!empty($comment->user_id)){
26 $user=get_userdata($comment->user_id);
27 $author=$user->user_login;
29 $author = __('Anonymous');
32 $author = $comment->comment_author;
34 return apply_filters('get_comment_author', $author);
38 * Displays the author of the current comment.
41 * @uses apply_filters() Calls 'comment_author' on comment author before displaying
43 function comment_author() {
44 $author = apply_filters('comment_author', get_comment_author() );
49 * Retrieve the email of the author of the current comment.
52 * @uses apply_filters() Calls the 'get_comment_author_email' hook on the comment author email
55 * @return string The current comment author's email
57 function get_comment_author_email() {
59 return apply_filters('get_comment_author_email', $comment->comment_author_email);
63 * Display the email of the author of the current global $comment.
65 * Care should be taken to protect the email address and assure that email
66 * harvesters do not capture your commentors' email address. Most assume that
67 * their email address will not appear in raw form on the blog. Doing so will
68 * enable anyone, including those that people don't want to get the email
69 * address and use it for their own means good and bad.
72 * @uses apply_filters() Calls 'author_email' hook on the author email
74 function comment_author_email() {
75 echo apply_filters('author_email', get_comment_author_email() );
79 * Display the html email link to the author of the current comment.
81 * Care should be taken to protect the email address and assure that email
82 * harvesters do not capture your commentors' email address. Most assume that
83 * their email address will not appear in raw form on the blog. Doing so will
84 * enable anyone, including those that people don't want to get the email
85 * address and use it for their own means good and bad.
88 * @uses apply_filters() Calls 'comment_email' hook for the display of the comment author's email
89 * @uses get_comment_author_email_link() For generating the link
90 * @global object $comment The current Comment row object
92 * @param string $linktext The text to display instead of the comment author's email address
93 * @param string $before The text or HTML to display before the email link.
94 * @param string $after The text or HTML to display after the email link.
96 function comment_author_email_link($linktext='', $before='', $after='') {
97 if ( $link = get_comment_author_email_link( $linktext, $before, $after ) )
102 * Return the html email link to the author of the current comment.
104 * Care should be taken to protect the email address and assure that email
105 * harvesters do not capture your commentors' email address. Most assume that
106 * their email address will not appear in raw form on the blog. Doing so will
107 * enable anyone, including those that people don't want to get the email
108 * address and use it for their own means good and bad.
111 * @uses apply_filters() Calls 'comment_email' hook for the display of the comment author's email
112 * @global object $comment The current Comment row object
114 * @param string $linktext The text to display instead of the comment author's email address
115 * @param string $before The text or HTML to display before the email link.
116 * @param string $after The text or HTML to display after the email link.
118 function get_comment_author_email_link($linktext='', $before='', $after='') {
120 $email = apply_filters('comment_email', $comment->comment_author_email);
121 if ((!empty($email)) && ($email != '@')) {
122 $display = ($linktext != '') ? $linktext : $email;
124 $return .= "<a href='mailto:$email'>$display</a>";
133 * Retrieve the html link to the url of the author of the current comment.
136 * @uses apply_filters() Calls 'get_comment_author_link' hook on the complete link HTML or author
138 * @return string Comment Author name or HTML link for author's URL
140 function get_comment_author_link() {
141 /** @todo Only call these functions when they are needed. Include in if... else blocks */
142 $url = get_comment_author_url();
143 $author = get_comment_author();
145 if ( empty( $url ) || 'http://' == $url )
148 $return = "<a href='$url' rel='external nofollow' class='url'>$author</a>";
149 return apply_filters('get_comment_author_link', $return);
153 * Display the html link to the url of the author of the current comment.
156 * @see get_comment_author_link() Echos result
158 function comment_author_link() {
159 echo get_comment_author_link();
163 * Retrieve the IP address of the author of the current comment.
167 * @uses apply_filters()
171 function get_comment_author_IP() {
173 return apply_filters('get_comment_author_IP', $comment->comment_author_IP);
177 * Display the IP address of the author of the current comment.
180 * @see get_comment_author_IP() Echos Result
182 function comment_author_IP() {
183 echo get_comment_author_IP();
187 * Retrieve the url of the author of the current comment.
190 * @uses apply_filters() Calls 'get_comment_author_url' hook on the comment author's URL
194 function get_comment_author_url() {
196 return apply_filters('get_comment_author_url', $comment->comment_author_url);
200 * Display the url of the author of the current comment.
203 * @uses apply_filters()
204 * @uses get_comment_author_url() Retrieves the comment author's URL
206 function comment_author_url() {
207 echo apply_filters('comment_url', get_comment_author_url());
211 * Retrieves the HTML link of the url of the author of the current comment.
213 * $linktext parameter is only used if the URL does not exist for the comment
214 * author. If the URL does exist then the URL will be used and the $linktext
217 * Encapsulate the HTML link between the $before and $after. So it will appear
218 * in the order of $before, link, and finally $after.
221 * @uses apply_filters() Calls the 'get_comment_author_url_link' on the complete HTML before returning.
223 * @param string $linktext The text to display instead of the comment author's email address
224 * @param string $before The text or HTML to display before the email link.
225 * @param string $after The text or HTML to display after the email link.
226 * @return string The HTML link between the $before and $after parameters
228 function get_comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
229 $url = get_comment_author_url();
230 $display = ($linktext != '') ? $linktext : $url;
231 $display = str_replace( 'http://www.', '', $display );
232 $display = str_replace( 'http://', '', $display );
233 if ( '/' == substr($display, -1) )
234 $display = substr($display, 0, -1);
235 $return = "$before<a href='$url' rel='external'>$display</a>$after";
236 return apply_filters('get_comment_author_url_link', $return);
240 * Displays the HTML link of the url of the author of the current comment.
243 * @see get_comment_author_url_link() Echos result
245 * @param string $linktext The text to display instead of the comment author's email address
246 * @param string $before The text or HTML to display before the email link.
247 * @param string $after The text or HTML to display after the email link.
249 function comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
250 echo get_comment_author_url_link( $linktext, $before, $after );
254 * Generates semantic classes for each comment element
258 * @param string|array $class One or more classes to add to the class list
259 * @param int $comment_id An optional comment ID
260 * @param int $post_id An optional post ID
261 * @param bool $echo Whether comment_class should echo or return
263 function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {
264 // Separates classes with a single space, collates classes for comment DIV
265 $class = 'class="' . join( ' ', get_comment_class( $class, $comment_id, $post_id ) ) . '"';
273 * Returns the classes for the comment div as an array
277 * @param string|array $class One or more classes to add to the class list
278 * @param int $comment_id An optional comment ID
279 * @param int $post_id An optional post ID
280 * @return array Array of classes
282 function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
283 global $comment_alt, $comment_depth, $comment_thread_alt;
285 $comment = get_comment($comment_id);
289 // Get the comment type (comment, trackback),
290 $classes[] = ( empty( $comment->comment_type ) ) ? 'comment' : $comment->comment_type;
292 // If the comment author has an id (registered), then print the log in name
293 if ( $comment->user_id > 0 && $user = get_userdata($comment->user_id) ) {
294 // For all registered users, 'byuser'
295 $classes[] = 'byuser comment-author-' . $user->user_nicename;
296 // For comment authors who are the author of the post
297 if ( $post = get_post($post_id) ) {
298 if ( $comment->user_id === $post->post_author )
299 $classes[] = 'bypostauthor';
303 if ( empty($comment_alt) )
305 if ( empty($comment_depth) )
307 if ( empty($comment_thread_alt) )
308 $comment_thread_alt = 0;
310 if ( $comment_alt % 2 ) {
319 // Alt for top-level comments
320 if ( 1 == $comment_depth ) {
321 if ( $comment_thread_alt % 2 ) {
322 $classes[] = 'thread-odd';
323 $classes[] = 'thread-alt';
325 $classes[] = 'thread-even';
327 $comment_thread_alt++;
330 $classes[] = "depth-$comment_depth";
332 if ( !empty($class) ) {
333 if ( !is_array( $class ) )
334 $class = preg_split('#\s+#', $class);
335 $classes = array_merge($classes, $class);
338 return apply_filters('comment_class', $classes, $class, $comment_id, $post_id);
342 * Retrieve the comment date of the current comment.
345 * @uses apply_filters() Calls 'get_comment_date' hook with the formated date and the $d parameter respectively
348 * @param string $d The format of the date (defaults to user's config)
349 * @return string The comment's date
351 function get_comment_date( $d = '' ) {
354 $date = mysql2date( get_option('date_format'), $comment->comment_date);
356 $date = mysql2date($d, $comment->comment_date);
357 return apply_filters('get_comment_date', $date, $d);
361 * Display the comment date of the current comment.
365 * @param string $d The format of the date (defaults to user's config)
367 function comment_date( $d = '' ) {
368 echo get_comment_date( $d );
372 * Retrieve the excerpt of the current comment.
374 * Will cut each word and only output the first 20 words with '...' at the end.
375 * If the word count is less than 20, then no truncating is done and no '...'
380 * @uses apply_filters() Calls 'get_comment_excerpt' on truncated comment
382 * @return string The maybe truncated comment with 20 words or less
384 function get_comment_excerpt() {
386 $comment_text = strip_tags($comment->comment_content);
387 $blah = explode(' ', $comment_text);
388 if (count($blah) > 20) {
396 for ($i=0; $i<$k; $i++) {
397 $excerpt .= $blah[$i] . ' ';
399 $excerpt .= ($use_dotdotdot) ? '...' : '';
400 return apply_filters('get_comment_excerpt', $excerpt);
404 * Display the excerpt of the current comment.
407 * @uses apply_filters() Calls 'comment_excerpt' hook before displaying excerpt
409 function comment_excerpt() {
410 echo apply_filters('comment_excerpt', get_comment_excerpt() );
414 * Retrieve the comment id of the current comment.
418 * @uses apply_filters() Calls the 'get_comment_ID' hook for the comment ID
420 * @return int The comment ID
422 function get_comment_ID() {
424 return apply_filters('get_comment_ID', $comment->comment_ID);
428 * Displays the comment id of the current comment.
431 * @see get_comment_ID() Echos Result
433 function comment_ID() {
434 echo get_comment_ID();
438 * Retrieve the link to a given comment.
443 * @param object|string|int $comment Comment to retrieve.
444 * @param array $args Optional args.
445 * @return string The permalink to the current comment
447 function get_comment_link( $comment = null, $args = array() ) {
448 global $wp_rewrite, $in_comment_loop;
450 $comment = get_comment($comment);
453 if ( !is_array($args) ) {
456 $args['page'] = $page;
459 $defaults = array( 'type' => 'all', 'page' => '', 'per_page' => '', 'max_depth' => '' );
460 $args = wp_parse_args( $args, $defaults );
462 if ( '' === $args['per_page'] && get_option('page_comments') )
463 $args['per_page'] = get_option('comments_per_page');
465 if ( empty($args['per_page']) ) {
466 $args['per_page'] = 0;
470 if ( $args['per_page'] ) {
471 if ( '' == $args['page'] )
472 $args['page'] = ( !empty($in_comment_loop) ) ? get_query_var('cpage') : get_page_of_comment( $comment->comment_ID, $args );
474 if ( $wp_rewrite->using_permalinks() )
475 return user_trailingslashit( trailingslashit( get_permalink( $comment->comment_post_ID ) ) . 'comment-page-' . $args['page'], 'comment' ) . '#comment-' . $comment->comment_ID;
477 return add_query_arg( 'cpage', $args['page'], get_permalink( $comment->comment_post_ID ) ) . '#comment-' . $comment->comment_ID;
479 return get_permalink( $comment->comment_post_ID ) . '#comment-' . $comment->comment_ID;
484 * Retrieves the link to the current post comments.
488 * @return string The link to the comments
490 function get_comments_link() {
491 return get_permalink() . '#comments';
495 * Displays the link to the current post comments.
499 * @param string $deprecated Not Used
500 * @param bool $deprecated Not Used
502 function comments_link( $deprecated = '', $deprecated = '' ) {
503 echo get_comments_link();
507 * Retrieve the amount of comments a post has.
510 * @uses apply_filters() Calls the 'get_comments_number' hook on the number of comments
512 * @param int $post_id The Post ID
513 * @return int The number of comments a post has
515 function get_comments_number( $post_id = 0 ) {
517 $post_id = (int) $post_id;
520 $post_id = (int) $id;
522 $post = get_post($post_id);
523 if ( ! isset($post->comment_count) )
526 $count = $post->comment_count;
528 return apply_filters('get_comments_number', $count);
532 * Display the language string for the number of comments the current post has.
536 * @uses apply_filters() Calls the 'comments_number' hook on the output and number of comments respectively.
538 * @param string $zero Text for no comments
539 * @param string $one Text for one comment
540 * @param string $more Text for more than one comment
541 * @param string $deprecated Not used.
543 function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {
545 $number = get_comments_number($id);
548 $output = str_replace('%', number_format_i18n($number), ( false === $more ) ? __('% Comments') : $more);
549 elseif ( $number == 0 )
550 $output = ( false === $zero ) ? __('No Comments') : $zero;
552 $output = ( false === $one ) ? __('1 Comment') : $one;
554 echo apply_filters('comments_number', $output, $number);
558 * Retrieve the text of the current comment.
563 * @return string The comment content
565 function get_comment_text() {
567 return apply_filters('get_comment_text', $comment->comment_content);
571 * Displays the text of the current comment.
574 * @uses apply_filters() Passes the comment content through the 'comment_text' hook before display
575 * @uses get_comment_text() Gets the comment content
577 function comment_text() {
578 echo apply_filters('comment_text', get_comment_text() );
582 * Retrieve the comment time of the current comment.
586 * @uses apply_filter() Calls 'get_comment_time' hook with the formatted time, the $d parameter, and $gmt parameter passed.
588 * @param string $d Optional. The format of the time (defaults to user's config)
589 * @param bool $gmt Whether to use the GMT date
590 * @return string The formatted time
592 function get_comment_time( $d = '', $gmt = false ) {
594 $comment_date = $gmt? $comment->comment_date_gmt : $comment->comment_date;
596 $date = mysql2date(get_option('time_format'), $comment_date);
598 $date = mysql2date($d, $comment_date);
599 return apply_filters('get_comment_time', $date, $d, $gmt);
603 * Display the comment time of the current comment.
607 * @param string $d Optional. The format of the time (defaults to user's config)
609 function comment_time( $d = '' ) {
610 echo get_comment_time($d);
614 * Retrieve the comment type of the current comment.
618 * @uses apply_filters() Calls the 'get_comment_type' hook on the comment type
620 * @return string The comment type
622 function get_comment_type() {
625 if ( '' == $comment->comment_type )
626 $comment->comment_type = 'comment';
628 return apply_filters('get_comment_type', $comment->comment_type);
632 * Display the comment type of the current comment.
636 * @param string $commenttxt The string to display for comment type
637 * @param string $trackbacktxt The string to display for trackback type
638 * @param string $pingbacktxt The string to display for pingback type
640 function comment_type($commenttxt = 'Comment', $trackbacktxt = 'Trackback', $pingbacktxt = 'Pingback') {
641 $type = get_comment_type();
655 * Retrieve The current post's trackback URL.
657 * There is a check to see if permalink's have been enabled and if so, will
658 * retrieve the pretty path. If permalinks weren't enabled, the ID of the
659 * current post is used and appended to the correct page to go to.
662 * @uses apply_filters() Calls 'trackback_url' on the resulting trackback URL
665 * @return string The trackback URL after being filtered
667 function get_trackback_url() {
669 if ( '' != get_option('permalink_structure') ) {
670 $tb_url = trailingslashit(get_permalink()) . user_trailingslashit('trackback', 'single_trackback');
672 $tb_url = get_option('siteurl') . '/wp-trackback.php?p=' . $id;
674 return apply_filters('trackback_url', $tb_url);
678 * Displays the current post's trackback URL.
681 * @uses get_trackback_url() Gets the trackback url for the current post
683 * @param bool $deprecated Remove backwards compat in 2.5
684 * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead.
686 function trackback_url($deprecated = true) {
687 if ($deprecated) echo get_trackback_url();
688 else return get_trackback_url();
692 * Generates and displays the RDF for the trackback information of current post.
696 * @param int $deprecated Not used (Was $timezone = 0)
698 function trackback_rdf($deprecated = '') {
699 if (stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') === false) {
700 echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
701 xmlns:dc="http://purl.org/dc/elements/1.1/"
702 xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
703 <rdf:Description rdf:about="';
706 echo ' dc:identifier="';
709 echo ' dc:title="'.str_replace('--', '--', wptexturize(strip_tags(get_the_title()))).'"'."\n";
710 echo ' trackback:ping="'.get_trackback_url().'"'." />\n";
716 * Whether the current post is open for comments.
721 * @param int $post_id An optional post ID to check instead of the current post.
722 * @return bool True if the comments are open
724 function comments_open( $post_id=NULL ) {
726 $_post = get_post($post_id);
728 $open = ( 'open' == $_post->comment_status );
729 return apply_filters( 'comments_open', $open, $post_id );
733 * Whether the current post is open for pings.
738 * @param int $post_id An optional post ID to check instead of the current post.
739 * @return bool True if pings are accepted
741 function pings_open( $post_id = NULL ) {
743 $_post = get_post($post_id);
745 $open = ( 'open' == $_post->ping_status );
746 return apply_filters( 'pings_open', $open, $post_id );
750 * Displays form token for unfiltered comments.
752 * Will only display nonce token if the current user has permissions for
753 * unfiltered html. Won't display the token for other users.
755 * The function was backported to 2.0.10 and was added to versions 2.1.3 and
756 * above. Does not exist in versions prior to 2.0.10 in the 2.0 branch and in
757 * the 2.1 branch, prior to 2.1.3. Technically added in 2.2.0.
759 * Backported to 2.0.10.
762 * @uses $post Gets the ID of the current post for the token
764 function wp_comment_form_unfiltered_html_nonce() {
769 $post_id = $post->ID;
771 if ( current_user_can('unfiltered_html') )
772 wp_nonce_field('unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment', false);
776 * Loads the comment template specified in $file.
778 * Will not display the comments template if not on single post or page, or if
779 * the post does not have comments.
781 * Uses the WordPress database object to query for the comments. The comments
782 * are passed through the 'comments_array' filter hook with the list of comments
783 * and the post ID respectively.
785 * The $file path is passed through a filter hook called, 'comments_template'
786 * which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
787 * first and if it fails it will require the default comment themplate from the
788 * default theme. If either does not exist, then the WordPress process will be
789 * halted. It is advised for that reason, that the default theme is not deleted.
792 * @global array $comment List of comment objects for the current post
796 * @uses $withcomments Will not try to get the comments if the post has none.
798 * @param string $file Optional, default '/comments.php'. The file to load
799 * @param bool $separate_comments Optional, whether to separate the comments by comment type. Default is false.
800 * @return null Returns null if no comments appear
802 function comments_template( $file = '/comments.php', $separate_comments = false ) {
803 global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity, $overridden_cpage;
805 if ( ! (is_single() || is_page() || $withcomments) )
809 $file = '/comments.php';
811 $req = get_option('require_name_email');
812 $commenter = wp_get_current_commenter();
813 extract($commenter, EXTR_SKIP);
815 /** @todo Use API instead of SELECTs. */
817 $comments = $wpdb->get_results($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND (comment_approved = '1' OR ( user_id = %d AND comment_approved = '0' ) ) ORDER BY comment_date", $post->ID, $user_ID));
818 } else if ( empty($comment_author) ) {
819 $comments = $wpdb->get_results($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved = '1' ORDER BY comment_date", $post->ID));
821 $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", $post->ID, $comment_author, $comment_author_email));
824 // keep $comments for legacy's sake
825 $wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID );
826 $comments = &$wp_query->comments;
827 $wp_query->comment_count = count($wp_query->comments);
828 update_comment_cache($wp_query->comments);
830 if ( $separate_comments ) {
831 $wp_query->comments_by_type = &separate_comments($comments);
832 $comments_by_type = &$wp_query->comments_by_type;
835 $overridden_cpage = FALSE;
836 if ( '' == get_query_var('cpage') && get_option('page_comments') ) {
837 set_query_var( 'cpage', 'newest' == get_option('default_comments_page') ? get_comment_pages_count() : 1 );
838 $overridden_cpage = TRUE;
841 define('COMMENTS_TEMPLATE', true);
843 $include = apply_filters('comments_template', STYLESHEETPATH . $file );
844 if ( file_exists( $include ) )
846 elseif ( file_exists( TEMPLATEPATH . $file ) )
847 require( TEMPLATEPATH . $file );
849 require( get_theme_root() . '/default/comments.php');
853 * Displays the JS popup script to show a comment.
855 * If the $file parameter is empty, then the home page is assumed. The defaults
856 * for the window are 400px by 400px.
858 * For the comment link popup to work, this function has to be called or the
859 * normal comment link will be assumed.
862 * @global string $wpcommentspopupfile The URL to use for the popup window
863 * @global int $wpcommentsjavascript Whether to use JavaScript or not. Set when function is called
865 * @param int $width Optional. The width of the popup window
866 * @param int $height Optional. The height of the popup window
867 * @param string $file Optional. Sets the location of the popup window
869 function comments_popup_script($width=400, $height=400, $file='') {
870 global $wpcommentspopupfile, $wpcommentsjavascript;
873 $wpcommentspopupfile = ''; // Use the index.
875 $wpcommentspopupfile = $file;
878 $wpcommentsjavascript = 1;
879 $javascript = "<script type='text/javascript'>\nfunction wpopen (macagna) {\n window.open(macagna, '_blank', 'width=$width,height=$height,scrollbars=yes,status=yes');\n}\n</script>\n";
884 * Displays the link to the comments popup window for the current post ID.
886 * Is not meant to be displayed on single posts and pages. Should be used on the
891 * @uses $wpcommentspopupfile
892 * @uses $wpcommentsjavascript
895 * @param string $zero The string to display when no comments
896 * @param string $one The string to display when only one comment is available
897 * @param string $more The string to display when there are more than one comment
898 * @param string $css_class The CSS class to use for comments
899 * @param string $none The string to display when comments have been turned off
900 * @return null Returns null on single posts and pages.
902 function comments_popup_link( $zero = 'No Comments', $one = '1 Comment', $more = '% Comments', $css_class = '', $none = 'Comments Off' ) {
903 global $id, $wpcommentspopupfile, $wpcommentsjavascript, $post;
905 if ( is_single() || is_page() )
908 $number = get_comments_number( $id );
910 if ( 0 == $number && 'closed' == $post->comment_status && 'closed' == $post->ping_status ) {
911 echo '<span' . ((!empty($css_class)) ? ' class="' . $css_class . '"' : '') . '>' . $none . '</span>';
915 if ( post_password_required() ) {
916 echo __('Enter your password to view comments');
921 if ( $wpcommentsjavascript ) {
922 if ( empty( $wpcommentspopupfile ) )
923 $home = get_option('home');
925 $home = get_option('siteurl');
926 echo $home . '/' . $wpcommentspopupfile . '?comments_popup=' . $id;
927 echo '" onclick="wpopen(this.href); return false"';
928 } else { // if comments_popup_script() is not in the template, display simple comment link
930 echo get_permalink() . '#respond';
936 if ( !empty( $css_class ) ) {
937 echo ' class="'.$css_class.'" ';
939 $title = attribute_escape( get_the_title() );
941 echo apply_filters( 'comments_popup_link_attributes', '' );
943 echo ' title="' . sprintf( __('Comment on %s'), $title ) . '">';
944 comments_number( $zero, $one, $more, $number );
949 * Retrieve HTML content for reply to comment link.
951 * The default arguments that can be override are 'add_below', 'respond_id',
952 * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be
953 * used, if the user must log in or register first before posting a comment. The
954 * 'reply_text' will be used, if they can post a reply. The 'add_below' and
955 * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function
960 * @param array $args Optional. Override default options.
961 * @param int $comment Optional. Comment being replied to.
962 * @param int $post Optional. Post that the comment is going to be displayed on.
963 * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
965 function get_comment_reply_link($args = array(), $comment = null, $post = null) {
968 $defaults = array('add_below' => 'comment', 'respond_id' => 'respond', 'reply_text' => __('Reply'),
969 'login_text' => __('Log in to Reply'), 'depth' => 0, 'before' => '', 'after' => '');
971 $args = wp_parse_args($args, $defaults);
973 if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] )
976 extract($args, EXTR_SKIP);
978 $comment = get_comment($comment);
979 $post = get_post($post);
981 if ( 'open' != $post->comment_status )
986 if ( get_option('comment_registration') && !$user_ID )
987 $link = '<a rel="nofollow" href="' . site_url('wp-login.php?redirect_to=' . get_permalink()) . '">' . $login_text . '</a>';
989 $link = "<a rel='nofollow' class='comment-reply-link' href='" . wp_specialchars( add_query_arg( 'replytocom', $comment->comment_ID ) ) . "#" . $respond_id . "' onclick='return addComment.moveForm(\"$add_below-$comment->comment_ID\", \"$comment->comment_ID\", \"$respond_id\", \"$post->ID\")'>$reply_text</a>";
990 return apply_filters('comment_reply_link', $before . $link . $after, $args, $comment, $post);
994 * Displays the HTML content for reply to comment link.
997 * @see get_comment_reply_link() Echoes result
999 * @param array $args Optional. Override default options.
1000 * @param int $comment Optional. Comment being replied to.
1001 * @param int $post Optional. Post that the comment is going to be displayed on.
1002 * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1004 function comment_reply_link($args = array(), $comment = null, $post = null) {
1005 echo get_comment_reply_link($args, $comment, $post);
1009 * Retrieve HTML content for reply to post link.
1011 * The default arguments that can be override are 'add_below', 'respond_id',
1012 * 'reply_text', 'login_text', and 'depth'. The 'login_text' argument will be
1013 * used, if the user must log in or register first before posting a comment. The
1014 * 'reply_text' will be used, if they can post a reply. The 'add_below' and
1015 * 'respond_id' arguments are for the JavaScript moveAddCommentForm() function
1020 * @param array $args Optional. Override default options.
1021 * @param int|object $post Optional. Post that the comment is going to be displayed on. Defaults to current post.
1022 * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1024 function get_post_reply_link($args = array(), $post = null) {
1027 $defaults = array('add_below' => 'post', 'respond_id' => 'respond', 'reply_text' => __('Leave a Comment'),
1028 'login_text' => __('Log in to leave a Comment'), 'before' => '', 'after' => '');
1030 $args = wp_parse_args($args, $defaults);
1031 extract($args, EXTR_SKIP);
1032 $post = get_post($post);
1034 if ( !comments_open($post->ID) )
1037 if ( get_option('comment_registration') && !$user_ID ) {
1038 $link = '<a rel="nofollow" href="' . site_url('wp-login.php?redirect_to=' . get_permalink()) . '">' . $login_text . '</a>';
1040 $link = "<a rel='nofollow' class='comment-reply-link' href='" . get_permalink($post->ID) . "#$respond_id' onclick='return addComment.moveForm(\"$add_below-$post->ID\", \"0\", \"$respond_id\", \"$post->ID\")'>$reply_text</a>";
1042 return apply_filters('post_comments_link', $before . $link . $after, $post);
1046 * Displays the HTML content for reply to post link.
1048 * @see get_post_reply_link()
1050 * @param array $args Optional. Override default options.
1051 * @param int|object $post Optional. Post that the comment is going to be displayed on.
1052 * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
1054 function post_reply_link($args = array(), $post = null) {
1055 echo get_post_reply_link($args, $post);
1059 * Retrieve HTML content for cancel comment reply link.
1063 * @param string $text Optional. Text to display for cancel reply link.
1065 function get_cancel_comment_reply_link($text = '') {
1067 $text = __('Click here to cancel reply.');
1069 $style = isset($_GET['replytocom']) ? '' : ' style="display:none;"';
1070 $link = wp_specialchars( remove_query_arg('replytocom') ) . '#respond';
1071 return apply_filters('cancel_comment_reply_link', '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>', $link, $text);
1075 * Display HTML content for cancel comment reply link.
1079 * @param string $text Optional. Text to display for cancel reply link.
1081 function cancel_comment_reply_link($text = '') {
1082 echo get_cancel_comment_reply_link($text);
1086 * Output hidden input HTML for replying to comments.
1090 function comment_id_fields() {
1093 $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
1094 echo "<input type='hidden' name='comment_post_ID' value='$id' id='comment_post_ID' />\n";
1095 echo "<input type='hidden' name='comment_parent' id='comment_parent' value='$replytoid' />\n";
1099 * Display text based on comment reply status. Only affects users with Javascript disabled.
1103 * @param string $noreplytext Optional. Text to display when not replying to a comment.
1104 * @param string $replytext Optional. Text to display when replying to a comment. Accepts "%s" for the author of the comment being replied to.
1105 * @param string $linktoparent Optional. Boolean to control making the author's name a link to their comment.
1107 function comment_form_title( $noreplytext = 'Leave a Reply', $replytext = 'Leave a Reply to %s', $linktoparent = TRUE ) {
1110 $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
1112 if ( 0 == $replytoid )
1115 $comment = get_comment($replytoid);
1116 $author = ( $linktoparent ) ? '<a href="#comment-' . get_comment_ID() . '">' . get_comment_author() . '</a>' : get_comment_author();
1117 printf( $replytext, $author );
1122 * HTML comment list class.
1124 * @package WordPress
1128 class Walker_Comment extends Walker {
1130 * @see Walker::$tree_type
1134 var $tree_type = 'comment';
1137 * @see Walker::$db_fields
1141 var $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
1144 * @see Walker::start_lvl()
1147 * @param string $output Passed by reference. Used to append additional content.
1148 * @param int $depth Depth of comment.
1149 * @param array $args Uses 'style' argument for type of HTML list.
1151 function start_lvl(&$output, $depth, $args) {
1152 $GLOBALS['comment_depth'] = $depth + 1;
1154 switch ( $args['style'] ) {
1158 echo "<ol class='children'>\n";
1162 echo "<ul class='children'>\n";
1168 * @see Walker::end_lvl()
1171 * @param string $output Passed by reference. Used to append additional content.
1172 * @param int $depth Depth of comment.
1173 * @param array $args Will only append content if style argument value is 'ol' or 'ul'.
1175 function end_lvl(&$output, $depth, $args) {
1176 $GLOBALS['comment_depth'] = $depth + 1;
1178 switch ( $args['style'] ) {
1192 * @see Walker::start_el()
1195 * @param string $output Passed by reference. Used to append additional content.
1196 * @param object $comment Comment data object.
1197 * @param int $depth Depth of comment in reference to parents.
1198 * @param array $args
1200 function start_el(&$output, $comment, $depth, $args) {
1202 $GLOBALS['comment_depth'] = $depth;
1204 if ( !empty($args['callback']) ) {
1205 call_user_func($args['callback'], $comment, $args, $depth);
1209 $GLOBALS['comment'] = $comment;
1210 extract($args, EXTR_SKIP);
1212 if ( 'div' == $args['style'] ) {
1214 $add_below = 'comment';
1217 $add_below = 'div-comment';
1220 <<?php echo $tag ?> <?php comment_class(empty( $args['has_children'] ) ? '' : 'parent') ?> id="comment-<?php comment_ID() ?>">
1221 <?php if ( 'ul' == $args['style'] ) : ?>
1222 <div id="div-comment-<?php comment_ID() ?>">
1224 <div class="comment-author vcard">
1225 <?php if ($args['avatar_size'] != 0) echo get_avatar( $comment, $args['avatar_size'] ); ?>
1226 <?php printf(__('<cite class="fn">%s</cite> <span class="says">says:</span>'), get_comment_author_link()) ?>
1228 <?php if ($comment->comment_approved == '0') : ?>
1229 <em><?php _e('Your comment is awaiting moderation.') ?></em>
1233 <div class="comment-meta commentmetadata"><a href="<?php echo htmlspecialchars( get_comment_link( $comment->comment_ID ) ) ?>"><?php printf(__('%1$s at %2$s'), get_comment_date(), get_comment_time()) ?></a><?php edit_comment_link(__('(Edit)'),' ','') ?></div>
1235 <?php comment_text() ?>
1238 <?php comment_reply_link(array_merge( $args, array('add_below' => $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth']))) ?>
1240 <?php if ( 'ul' == $args['style'] ) : ?>
1247 * @see Walker::end_el()
1250 * @param string $output Passed by reference. Used to append additional content.
1251 * @param object $comment
1252 * @param int $depth Depth of comment.
1253 * @param array $args
1255 function end_el(&$output, $comment, $depth, $args) {
1256 if ( !empty($args['end-callback']) ) {
1257 call_user_func($args['end-callback'], $comment, $args, $depth);
1260 if ( 'div' == $args['style'] )
1271 * Used in the comments.php template to list comments for a particular post
1274 * @uses Walker_Comment
1276 * @param string|array $args Formatting options
1277 * @param array $comments Optional array of comment objects. Defaults to $wp_query->comments
1279 function wp_list_comments($args = array(), $comments = null ) {
1280 global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;
1282 $in_comment_loop = true;
1284 $comment_alt = $comment_thread_alt = 0;
1287 $defaults = array('walker' => null, 'max_depth' => '', 'style' => 'ul', 'callback' => null, 'end-callback' => null, 'type' => 'all',
1288 'page' => '', 'per_page' => '', 'avatar_size' => 32, 'reverse_top_level' => null, 'reverse_children' => '');
1290 $r = wp_parse_args( $args, $defaults );
1292 // Figure out what comments we'll be looping through ($_comments)
1293 if ( null !== $comments ) {
1294 $comments = (array) $comments;
1295 if ( empty($comments) )
1297 if ( 'all' != $r['type'] ) {
1298 $comments_by_type = &separate_comments($comments);
1299 if ( empty($comments_by_type[$r['type']]) )
1301 $_comments = $comments_by_type[$r['type']];
1303 $_comments = $comments;
1306 if ( empty($wp_query->comments) )
1308 if ( 'all' != $r['type'] ) {
1309 if ( empty($wp_query->comments_by_type) )
1310 $wp_query->comments_by_type = &separate_comments($wp_query->comments);
1311 if ( empty($wp_query->comments_by_type[$r['type']]) )
1313 $_comments = $wp_query->comments_by_type[$r['type']];
1315 $_comments = $wp_query->comments;
1319 if ( '' === $r['per_page'] && get_option('page_comments') )
1320 $r['per_page'] = get_query_var('comments_per_page');
1322 if ( empty($r['per_page']) ) {
1327 if ( '' === $r['max_depth'] ) {
1328 if ( get_option('thread_comments') )
1329 $r['max_depth'] = get_option('thread_comments_depth');
1331 $r['max_depth'] = -1;
1334 if ( '' === $r['page'] ) {
1335 if ( empty($overridden_cpage) ) {
1336 $r['page'] = get_query_var('cpage');
1338 $threaded = ( -1 == $r['max_depth'] ) ? false : true;
1339 $r['page'] = ( 'newest' == get_option('default_comments_page') ) ? get_comment_pages_count($_comments, $r['per_page'], $threaded) : 1;
1340 set_query_var( 'cpage', $r['page'] );
1344 $r['page'] = intval($r['page']);
1345 if ( 0 == $r['page'] && 0 != $r['per_page'] )
1348 if ( null === $r['reverse_top_level'] )
1349 $r['reverse_top_level'] = ( 'desc' == get_option('comment_order') ) ? TRUE : FALSE;
1351 extract( $r, EXTR_SKIP );
1353 if ( empty($walker) )
1354 $walker = new Walker_Comment;
1356 $walker->paged_walk($_comments, $max_depth, $page, $per_page, $r);
1357 $wp_query->max_num_comment_pages = $walker->max_pages;
1359 $in_comment_loop = false;