/wp-includes/comment-template.php
https://gitlab.com/Blueprint-Marketing/WordPress-1 · PHP · 1475 lines · 516 code · 141 blank · 818 comment · 122 complexity · 242999acc09a320b0efadaf686633159 MD5 · raw file
- <?php
- /**
- * Comment template functions
- *
- * These functions are meant to live inside of the WordPress loop.
- *
- * @package WordPress
- * @subpackage Template
- */
- /**
- * Retrieve the author of the current comment.
- *
- * If the comment has an empty comment_author field, then 'Anonymous' person is
- * assumed.
- *
- * @since 1.5.0
- *
- * @param int $comment_ID Optional. The ID of the comment for which to retrieve the author. Default current comment.
- * @return string The comment author
- */
- function get_comment_author( $comment_ID = 0 ) {
- $comment = get_comment( $comment_ID );
- if ( empty( $comment->comment_author ) ) {
- if ( $comment->user_id && $user = get_userdata( $comment->user_id ) )
- $author = $user->display_name;
- else
- $author = __('Anonymous');
- } else {
- $author = $comment->comment_author;
- }
- /**
- * Filter the returned comment author name.
- *
- * @since 1.5.0
- *
- * @param string $author The comment author's username.
- */
- return apply_filters( 'get_comment_author', $author );
- }
- /**
- * Displays the author of the current comment.
- *
- * @since 0.71
- *
- * @param int $comment_ID Optional. The ID of the comment for which to print the author. Default current comment.
- */
- function comment_author( $comment_ID = 0 ) {
- $author = get_comment_author( $comment_ID );
- /**
- * Filter the comment author's name for display.
- *
- * @since 1.2.0
- *
- * @param string $author The comment author's username.
- */
- $author = apply_filters( 'comment_author', $author );
- echo $author;
- }
- /**
- * Retrieve the email of the author of the current comment.
- *
- * @since 1.5.0
- *
- * @param int $comment_ID Optional. The ID of the comment for which to get the author's email. Default current comment.
- * @return string The current comment author's email
- */
- function get_comment_author_email( $comment_ID = 0 ) {
- $comment = get_comment( $comment_ID );
- /**
- * Filter the comment author's returned email address.
- *
- * @since 1.5.0
- *
- * @param string $comment->comment_author_email The comment author's email address.
- */
- return apply_filters( 'get_comment_author_email', $comment->comment_author_email );
- }
- /**
- * Display the email of the author of the current global $comment.
- *
- * Care should be taken to protect the email address and assure that email
- * harvesters do not capture your commentors' email address. Most assume that
- * their email address will not appear in raw form on the blog. Doing so will
- * enable anyone, including those that people don't want to get the email
- * address and use it for their own means good and bad.
- *
- * @since 0.71
- *
- * @param int $comment_ID Optional. The ID of the comment for which to print the author's email. Default current comment.
- */
- function comment_author_email( $comment_ID = 0 ) {
- $author_email = get_comment_author_email( $comment_ID );
- /**
- * Filter the comment author's email for display.
- *
- * @since 1.2.0
- *
- * @param string $author_email The comment author's email address.
- */
- echo apply_filters( 'author_email', $author_email );
- }
- /**
- * Display the html email link to the author of the current comment.
- *
- * Care should be taken to protect the email address and assure that email
- * harvesters do not capture your commentors' email address. Most assume that
- * their email address will not appear in raw form on the blog. Doing so will
- * enable anyone, including those that people don't want to get the email
- * address and use it for their own means good and bad.
- *
- * @global object $comment The current Comment row object
- * @since 0.71
- *
- * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.
- * @param string $before Optional. The text or HTML to display before the email link.Default empty.
- * @param string $after Optional. The text or HTML to display after the email link. Default empty.
- */
- function comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
- if ( $link = get_comment_author_email_link( $linktext, $before, $after ) )
- echo $link;
- }
- /**
- * Return the html email link to the author of the current comment.
- *
- * Care should be taken to protect the email address and assure that email
- * harvesters do not capture your commentors' email address. Most assume that
- * their email address will not appear in raw form on the blog. Doing so will
- * enable anyone, including those that people don't want to get the email
- * address and use it for their own means good and bad.
- *
- * @global object $comment The current Comment row object.
- *
- * @since 2.7
- *
- * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.
- * @param string $before Optional. The text or HTML to display before the email link. Default empty.
- * @param string $after Optional. The text or HTML to display after the email link. Default empty.
- */
- function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
- global $comment;
- /**
- * Filter the comment author's email for display.
- *
- * Care should be taken to protect the email address and assure that email
- * harvesters do not capture your commentors' email address.
- *
- * @since 1.2.0
- *
- * @param string $comment->comment_author_email The comment author's email address.
- */
- $email = apply_filters( 'comment_email', $comment->comment_author_email );
- if ((!empty($email)) && ($email != '@')) {
- $display = ($linktext != '') ? $linktext : $email;
- $return = $before;
- $return .= "<a href='mailto:$email'>$display</a>";
- $return .= $after;
- return $return;
- } else {
- return '';
- }
- }
- /**
- * Retrieve the HTML link to the URL of the author of the current comment.
- *
- * Both get_comment_author_url() and get_comment_author() rely on get_comment(),
- * which falls back to the global comment variable if the $comment_ID argument is empty.
- *
- * @since 1.5.0
- *
- * @param int $comment_ID Optional. The ID of the comment for which to get the author's link. Default current comment.
- * @return string The comment author name or HTML link for author's URL.
- */
- function get_comment_author_link( $comment_ID = 0 ) {
- $url = get_comment_author_url( $comment_ID );
- $author = get_comment_author( $comment_ID );
- if ( empty( $url ) || 'http://' == $url )
- $return = $author;
- else
- $return = "<a href='$url' rel='external nofollow' class='url'>$author</a>";
- /**
- * Filter the comment author's link for display.
- *
- * @since 1.5.0
- *
- * @param string $return The HTML-formatted comment author link. Empty for an invalid URL.
- */
- return apply_filters( 'get_comment_author_link', $return );
- }
- /**
- * Display the html link to the url of the author of the current comment.
- *
- * @since 0.71
- * @see get_comment_author_link() Echoes result
- *
- * @param int $comment_ID Optional. The ID of the comment for which to print the author's link. Default current comment.
- */
- function comment_author_link( $comment_ID = 0 ) {
- echo get_comment_author_link( $comment_ID );
- }
- /**
- * Retrieve the IP address of the author of the current comment.
- *
- * @since 1.5.0
- *
- * @param int $comment_ID Optional. The ID of the comment for which to get the author's IP address. Default current comment.
- * @return string The comment author's IP address.
- */
- function get_comment_author_IP( $comment_ID = 0 ) {
- $comment = get_comment( $comment_ID );
- /**
- * Filter the comment author's returned IP address.
- *
- * @since 1.5.0
- *
- * @param string $comment->comment_author_IP The comment author's IP address.
- */
- return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP );
- }
- /**
- * Display the IP address of the author of the current comment.
- *
- * @since 0.71
- *
- * @param int $comment_ID Optional. The ID of the comment for which to print the author's IP address. Default current comment.
- */
- function comment_author_IP( $comment_ID = 0 ) {
- echo get_comment_author_IP( $comment_ID );
- }
- /**
- * Retrieve the url of the author of the current comment.
- *
- * @since 1.5.0
- *
- * @param int $comment_ID Optional. The ID of the comment for which to get the author's URL. Default current comment.
- * @return string
- */
- function get_comment_author_url( $comment_ID = 0 ) {
- $comment = get_comment( $comment_ID );
- $url = ('http://' == $comment->comment_author_url) ? '' : $comment->comment_author_url;
- $url = esc_url( $url, array('http', 'https') );
- /**
- * Filter the comment author's URL.
- *
- * @since 1.5.0
- *
- * @param string $url The comment author's URL.
- */
- return apply_filters( 'get_comment_author_url', $url );
- }
- /**
- * Display the url of the author of the current comment.
- *
- * @since 0.71
- *
- * @param int $comment_ID Optional. The ID of the comment for which to print the author's URL. Default current comment.
- */
- function comment_author_url( $comment_ID = 0 ) {
- $author_url = get_comment_author_url( $comment_ID );
- /**
- * Filter the comment author's URL for display.
- *
- * @since 1.2.0
- *
- * @param string $author_url The comment author's URL.
- */
- echo apply_filters( 'comment_url', $author_url );
- }
- /**
- * Retrieves the HTML link of the url of the author of the current comment.
- *
- * $linktext parameter is only used if the URL does not exist for the comment
- * author. If the URL does exist then the URL will be used and the $linktext
- * will be ignored.
- *
- * Encapsulate the HTML link between the $before and $after. So it will appear
- * in the order of $before, link, and finally $after.
- *
- * @since 1.5.0
- *
- * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.
- * @param string $before Optional. The text or HTML to display before the email link. Default empty.
- * @param string $after Optional. The text or HTML to display after the email link. Default empty.
- * @return string The HTML link between the $before and $after parameters.
- */
- function get_comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
- $url = get_comment_author_url();
- $display = ($linktext != '') ? $linktext : $url;
- $display = str_replace( 'http://www.', '', $display );
- $display = str_replace( 'http://', '', $display );
- if ( '/' == substr($display, -1) )
- $display = substr($display, 0, -1);
- $return = "$before<a href='$url' rel='external'>$display</a>$after";
- /**
- * Filter the comment author's returned URL link.
- *
- * @since 1.5.0
- *
- * @param string $return The HTML-formatted comment author URL link.
- */
- return apply_filters( 'get_comment_author_url_link', $return );
- }
- /**
- * Displays the HTML link of the url of the author of the current comment.
- *
- * @since 0.71
- *
- * @param string $linktext Optional. The text to display instead of the comment author's email address. Default empty.
- * @param string $before Optional. The text or HTML to display before the email link. Default empty.
- * @param string $after Optional. The text or HTML to display after the email link. Default empty.
- */
- function comment_author_url_link( $linktext = '', $before = '', $after = '' ) {
- echo get_comment_author_url_link( $linktext, $before, $after );
- }
- /**
- * Generates semantic classes for each comment element
- *
- * @since 2.7.0
- *
- * @param string|array $class Optional. One or more classes to add to the class list. Default empty.
- * @param int $comment_id Optional. Comment ID. Default current comment.
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
- * @param bool $echo Optional. Whether comment_class should echo or return. Default true.
- */
- function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {
- // Separates classes with a single space, collates classes for comment DIV
- $class = 'class="' . join( ' ', get_comment_class( $class, $comment_id, $post_id ) ) . '"';
- if ( $echo)
- echo $class;
- else
- return $class;
- }
- /**
- * Returns the classes for the comment div as an array
- *
- * @since 2.7.0
- *
- * @param string|array $class Optional. One or more classes to add to the class list. Default empty.
- * @param int $comment_id Optional. Comment ID. Default current comment.
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
- * @return array An array of classes.
- */
- function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
- global $comment_alt, $comment_depth, $comment_thread_alt;
- $comment = get_comment($comment_id);
- $classes = array();
- // Get the comment type (comment, trackback),
- $classes[] = ( empty( $comment->comment_type ) ) ? 'comment' : $comment->comment_type;
- // If the comment author has an id (registered), then print the log in name
- if ( $comment->user_id > 0 && $user = get_userdata($comment->user_id) ) {
- // For all registered users, 'byuser'
- $classes[] = 'byuser';
- $classes[] = 'comment-author-' . sanitize_html_class($user->user_nicename, $comment->user_id);
- // For comment authors who are the author of the post
- if ( $post = get_post($post_id) ) {
- if ( $comment->user_id === $post->post_author )
- $classes[] = 'bypostauthor';
- }
- }
- if ( empty($comment_alt) )
- $comment_alt = 0;
- if ( empty($comment_depth) )
- $comment_depth = 1;
- if ( empty($comment_thread_alt) )
- $comment_thread_alt = 0;
- if ( $comment_alt % 2 ) {
- $classes[] = 'odd';
- $classes[] = 'alt';
- } else {
- $classes[] = 'even';
- }
- $comment_alt++;
- // Alt for top-level comments
- if ( 1 == $comment_depth ) {
- if ( $comment_thread_alt % 2 ) {
- $classes[] = 'thread-odd';
- $classes[] = 'thread-alt';
- } else {
- $classes[] = 'thread-even';
- }
- $comment_thread_alt++;
- }
- $classes[] = "depth-$comment_depth";
- if ( !empty($class) ) {
- if ( !is_array( $class ) )
- $class = preg_split('#\s+#', $class);
- $classes = array_merge($classes, $class);
- }
- $classes = array_map('esc_attr', $classes);
- /**
- * Filter the returned CSS classes for the current comment.
- *
- * @since 2.7.0
- *
- * @param array $classes An array of comment classes.
- * @param string $class A comma-separated list of additional classes added to the list.
- * @param int $comment_id The comment id.
- * @param int|WP_Post $post_id The post ID or WP_Post object.
- */
- return apply_filters( 'comment_class', $classes, $class, $comment_id, $post_id );
- }
- /**
- * Retrieve the comment date of the current comment.
- *
- * @since 1.5.0
- *
- * @param string $d Optional. The format of the date. Default user's setting.
- * @param int $comment_ID Optional. The ID of the comment for which to get the date. Default current comment.
- * @return string The comment's date.
- */
- function get_comment_date( $d = '', $comment_ID = 0 ) {
- $comment = get_comment( $comment_ID );
- if ( '' == $d )
- $date = mysql2date(get_option('date_format'), $comment->comment_date);
- else
- $date = mysql2date($d, $comment->comment_date);
- /**
- * Filter the returned comment date.
- *
- * @since 1.5.0
- *
- * @param string|int $date Formatted date string or Unix timestamp.
- * @param string $d The format of the date.
- */
- return apply_filters( 'get_comment_date', $date, $d );
- }
- /**
- * Display the comment date of the current comment.
- *
- * @since 0.71
- *
- * @param string $d Optional. The format of the date. Default user's settings.
- * @param int $comment_ID Optional. The ID of the comment for which to print the date. Default current comment.
- */
- function comment_date( $d = '', $comment_ID = 0 ) {
- echo get_comment_date( $d, $comment_ID );
- }
- /**
- * Retrieve the excerpt of the current comment.
- *
- * Will cut each word and only output the first 20 words with '…' at the end.
- * If the word count is less than 20, then no truncating is done and no '…'
- * will appear.
- *
- * @since 1.5.0
- *
- * @param int $comment_ID Optional. The ID of the comment for which to get the excerpt. Default current comment.
- * @return string The maybe truncated comment with 20 words or less.
- */
- function get_comment_excerpt( $comment_ID = 0 ) {
- $comment = get_comment( $comment_ID );
- $comment_text = strip_tags($comment->comment_content);
- $blah = explode(' ', $comment_text);
- if (count($blah) > 20) {
- $k = 20;
- $use_dotdotdot = 1;
- } else {
- $k = count($blah);
- $use_dotdotdot = 0;
- }
- $excerpt = '';
- for ($i=0; $i<$k; $i++) {
- $excerpt .= $blah[$i] . ' ';
- }
- $excerpt .= ($use_dotdotdot) ? '…' : '';
- return apply_filters('get_comment_excerpt', $excerpt);
- }
- /**
- * Display the excerpt of the current comment.
- *
- * @since 1.2.0
- *
- * @param int $comment_ID Optional. The ID of the comment for which to print the excerpt. Default current comment.
- */
- function comment_excerpt( $comment_ID = 0 ) {
- $comment_excerpt = get_comment_excerpt($comment_ID);
- /**
- * Filter the comment excerpt for display.
- *
- * @since 1.2.0
- *
- * @param string $comment_excerpt The comment excerpt text.
- */
- echo apply_filters( 'comment_excerpt', $comment_excerpt );
- }
- /**
- * Retrieve the comment id of the current comment.
- *
- * @since 1.5.0
- *
- * @return int The comment ID.
- */
- function get_comment_ID() {
- global $comment;
- /**
- * Filter the returned comment ID.
- *
- * @since 1.5.0
- *
- * @param int $comment->comment_ID The current comment ID.
- */
- return apply_filters( 'get_comment_ID', $comment->comment_ID );
- }
- /**
- * Display the comment id of the current comment.
- *
- * @since 0.71
- */
- function comment_ID() {
- echo get_comment_ID();
- }
- /**
- * Retrieve the link to a given comment.
- *
- * @since 1.5.0
- *
- * @param mixed $comment Optional. Comment to retrieve. Default current comment.
- * @param array $args Optional. An array of arguments to override the defaults. @see get_page_of_comment()
- * @return string The permalink to the given comment.
- */
- function get_comment_link( $comment = null, $args = array() ) {
- global $wp_rewrite, $in_comment_loop;
- $comment = get_comment($comment);
- // Backwards compat
- if ( !is_array($args) ) {
- $page = $args;
- $args = array();
- $args['page'] = $page;
- }
- $defaults = array( 'type' => 'all', 'page' => '', 'per_page' => '', 'max_depth' => '' );
- $args = wp_parse_args( $args, $defaults );
- if ( '' === $args['per_page'] && get_option('page_comments') )
- $args['per_page'] = get_option('comments_per_page');
- if ( empty($args['per_page']) ) {
- $args['per_page'] = 0;
- $args['page'] = 0;
- }
- if ( $args['per_page'] ) {
- if ( '' == $args['page'] )
- $args['page'] = ( !empty($in_comment_loop) ) ? get_query_var('cpage') : get_page_of_comment( $comment->comment_ID, $args );
- if ( $wp_rewrite->using_permalinks() )
- $link = user_trailingslashit( trailingslashit( get_permalink( $comment->comment_post_ID ) ) . 'comment-page-' . $args['page'], 'comment' );
- else
- $link = add_query_arg( 'cpage', $args['page'], get_permalink( $comment->comment_post_ID ) );
- } else {
- $link = get_permalink( $comment->comment_post_ID );
- }
- $link = $link . '#comment-' . $comment->comment_ID;
- /**
- * Filter the returned single comment permalink.
- *
- * @since 2.8.0
- *
- * @param string $link The comment permalink with '#comment-$id' appended.
- * @param object $comment The current comment object.
- * @param array $args An array of arguments to override the defaults. @see get_page_of_comment()
- */
- return apply_filters( 'get_comment_link', $link, $comment, $args );
- }
- /**
- * Retrieve the link to the current post comments.
- *
- * @since 1.5.0
- *
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
- * @return string The link to the comments.
- */
- function get_comments_link( $post_id = 0 ) {
- $comments_link = get_permalink( $post_id ) . '#comments';
- /**
- * Filter the returned post comments permalink.
- *
- * @since
- *
- * @param string $comments_link The post comments permalink with '#comments' appended.
- * @param int|WP_Post $post_id The post ID or WP_Post object.
- */
- return apply_filters( 'get_comments_link', $comments_link, $post_id );
- }
- /**
- * Display the link to the current post comments.
- *
- * @since 0.71
- *
- * @param string $deprecated Not Used.
- * @param bool $deprecated_2 Not Used.
- */
- function comments_link( $deprecated = '', $deprecated_2 = '' ) {
- if ( !empty( $deprecated ) )
- _deprecated_argument( __FUNCTION__, '0.72' );
- if ( !empty( $deprecated_2 ) )
- _deprecated_argument( __FUNCTION__, '1.3' );
- echo esc_url( get_comments_link() );
- }
- /**
- * Retrieve the amount of comments a post has.
- *
- * @since 1.5.0
- *
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
- * @return int The number of comments a post has.
- */
- function get_comments_number( $post_id = 0 ) {
- $post_id = absint( $post_id );
- if ( !$post_id )
- $post_id = get_the_ID();
- $post = get_post($post_id);
- if ( ! isset($post->comment_count) )
- $count = 0;
- else
- $count = $post->comment_count;
- /**
- * Filter the returned comment count for a post.
- *
- * @since 1.5.0
- *
- * @param int $count The number of comments a post has.
- * @param int|WP_Post $post_id The post ID or WP_Post object.
- */
- return apply_filters( 'get_comments_number', $count, $post_id );
- }
- /**
- * Display the language string for the number of comments the current post has.
- *
- * @since 0.71
- *
- * @param string $zero Optional. Text for no comments. Default false.
- * @param string $one Optional. Text for one comment. Default false.
- * @param string $more Optional. Text for more than one comment. Default false.
- * @param string $deprecated Not used.
- */
- function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {
- if ( !empty( $deprecated ) )
- _deprecated_argument( __FUNCTION__, '1.3' );
- $number = get_comments_number();
- if ( $number > 1 )
- $output = str_replace('%', number_format_i18n($number), ( false === $more ) ? __('% Comments') : $more);
- elseif ( $number == 0 )
- $output = ( false === $zero ) ? __('No Comments') : $zero;
- else // must be one
- $output = ( false === $one ) ? __('1 Comment') : $one;
- /**
- * Filter the comments count for display.
- *
- * @since 1.5.0
- *
- * @param string $output A translatable string formatted based on whether the count is equal to 0, 1, or 1+. @see _n()
- * @param int $number The number of post comments.
- */
- echo apply_filters( 'comments_number', $output, $number );
- }
- /**
- * Retrieve the text of the current comment.
- *
- * @since 1.5.0
- *
- * @param int $comment_ID Optional. The ID of the comment for which to get the text. Default current comment.
- * @param array $args Optional. An array of arguments. @see Walker_Comment::comment()
- * @return string The comment content.
- */
- function get_comment_text( $comment_ID = 0, $args = array() ) {
- $comment = get_comment( $comment_ID );
- /**
- * Filter the text of a comment.
- *
- * @since 1.5.0
- *
- * @param string $comment->comment_content The text of the comment.
- * @param object $comment The comment object.
- * @param array $args An array of arguments. @see Walker_Comment::comment()
- */
- return apply_filters( 'get_comment_text', $comment->comment_content, $comment, $args );
- }
- /**
- * Display the text of the current comment.
- *
- * @since 0.71
- *
- * @param int $comment_ID Optional. The ID of the comment for which to print the text.
- * Default 0.
- * @param array $args Optional. An array of arguments. @see Walker_Comment::comment()
- * Default empty array.
- */
- function comment_text( $comment_ID = 0, $args = array() ) {
- $comment = get_comment( $comment_ID );
- $comment_text = get_comment_text( $comment_ID , $args );
- /**
- * Filter the text of a comment to be displayed.
- *
- * @since 1.2.0
- *
- * @param string $comment_text The text of the current comment.
- * @param object $comment The comment object.
- * @param array $args An array of arguments. @see Walker_Comment::comment()
- */
- echo apply_filters( 'comment_text', $comment_text, $comment, $args );
- }
- /**
- * Retrieve the comment time of the current comment.
- *
- * @since 1.5.0
- *
- * @param string $d Optional. The format of the time. Default user's settings.
- * @param bool $gmt Optional. Whether to use the GMT date. Default false.
- * @param bool $translate Optional. Whether to translate the time (for use in feeds). Default true.
- * @return string The formatted time
- */
- function get_comment_time( $d = '', $gmt = false, $translate = true ) {
- global $comment;
- $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;
- if ( '' == $d )
- $date = mysql2date(get_option('time_format'), $comment_date, $translate);
- else
- $date = mysql2date($d, $comment_date, $translate);
- /**
- * Filter the returned comment time.
- *
- * @since 1.5.0
- *
- * @param string|int $date The comment time, formatted as a date string or Unix timestamp.
- * @param string $d The date format.
- * @param bool $gmt Whether the GMT date is in use.
- * @param bool $translate Whether the time is translated.
- */
- return apply_filters( 'get_comment_time', $date, $d, $gmt, $translate );
- }
- /**
- * Display the comment time of the current comment.
- *
- * @since 0.71
- *
- * @param string $d Optional. The format of the time. Default user's settings.
- */
- function comment_time( $d = '' ) {
- echo get_comment_time($d);
- }
- /**
- * Retrieve the comment type of the current comment.
- *
- * @since 1.5.0
- *
- * @param int $comment_ID Optional. The ID of the comment for which to get the type. Default current comment.
- * @return string The comment type
- */
- function get_comment_type( $comment_ID = 0 ) {
- $comment = get_comment( $comment_ID );
- if ( '' == $comment->comment_type )
- $comment->comment_type = 'comment';
- /**
- * Filter the returned comment type.
- *
- * @since 1.5.0
- *
- * @param string $comment->comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
- */
- return apply_filters( 'get_comment_type', $comment->comment_type );
- }
- /**
- * Display the comment type of the current comment.
- *
- * @since 0.71
- *
- * @param string $commenttxt Optional. The string to display for comment type. Default false.
- * @param string $trackbacktxt Optional. The string to display for trackback type. Default false.
- * @param string $pingbacktxt Optional. The string to display for pingback type. Default false.
- */
- function comment_type( $commenttxt = false, $trackbacktxt = false, $pingbacktxt = false ) {
- if ( false === $commenttxt ) $commenttxt = _x( 'Comment', 'noun' );
- if ( false === $trackbacktxt ) $trackbacktxt = __( 'Trackback' );
- if ( false === $pingbacktxt ) $pingbacktxt = __( 'Pingback' );
- $type = get_comment_type();
- switch( $type ) {
- case 'trackback' :
- echo $trackbacktxt;
- break;
- case 'pingback' :
- echo $pingbacktxt;
- break;
- default :
- echo $commenttxt;
- }
- }
- /**
- * Retrieve The current post's trackback URL.
- *
- * There is a check to see if permalink's have been enabled and if so, will
- * retrieve the pretty path. If permalinks weren't enabled, the ID of the
- * current post is used and appended to the correct page to go to.
- *
- * @since 1.5.0
- *
- * @return string The trackback URL after being filtered.
- */
- function get_trackback_url() {
- if ( '' != get_option('permalink_structure') )
- $tb_url = trailingslashit(get_permalink()) . user_trailingslashit('trackback', 'single_trackback');
- else
- $tb_url = get_option('siteurl') . '/wp-trackback.php?p=' . get_the_ID();
- /**
- * Filter the returned trackback URL.
- *
- * @since 2.2.0
- *
- * @param string $tb_url The trackback URL.
- */
- return apply_filters( 'trackback_url', $tb_url );
- }
- /**
- * Display the current post's trackback URL.
- *
- * @since 0.71
- *
- * @param bool $deprecated_echo Not used.
- * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead.
- */
- function trackback_url( $deprecated_echo = true ) {
- if ( $deprecated_echo !== true )
- _deprecated_argument( __FUNCTION__, '2.5', __('Use <code>get_trackback_url()</code> instead if you do not want the value echoed.') );
- if ( $deprecated_echo )
- echo get_trackback_url();
- else
- return get_trackback_url();
- }
- /**
- * Generate and display the RDF for the trackback information of current post.
- *
- * Deprecated in 3.0.0, and restored in 3.0.1.
- *
- * @since 0.71
- *
- * @param int $deprecated Not used (Was $timezone = 0).
- */
- function trackback_rdf( $deprecated = '' ) {
- if ( !empty( $deprecated ) )
- _deprecated_argument( __FUNCTION__, '2.5' );
- if ( false !== stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') )
- return;
- echo '<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
- <rdf:Description rdf:about="';
- the_permalink();
- echo '"'."\n";
- echo ' dc:identifier="';
- the_permalink();
- echo '"'."\n";
- echo ' dc:title="'.str_replace('--', '--', wptexturize(strip_tags(get_the_title()))).'"'."\n";
- echo ' trackback:ping="'.get_trackback_url().'"'." />\n";
- echo '</rdf:RDF>';
- }
- /**
- * Whether the current post is open for comments.
- *
- * @since 1.5.0
- *
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
- * @return bool True if the comments are open.
- */
- function comments_open( $post_id = null ) {
- $_post = get_post($post_id);
- $open = ( 'open' == $_post->comment_status );
- /**
- * Filter whether the current post is open for comments.
- *
- * @since
- *
- * @param bool $open Whether the current post is open for comments.
- * @param int|WP_Post $post_id The post ID or WP_Post object.
- */
- return apply_filters( 'comments_open', $open, $post_id );
- }
- /**
- * Whether the current post is open for pings.
- *
- * @since 1.5.0
- *
- * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
- * @return bool True if pings are accepted
- */
- function pings_open( $post_id = null ) {
- $_post = get_post($post_id);
- $open = ( 'open' == $_post->ping_status );
- return apply_filters( 'pings_open', $open, $post_id );
- }
- /**
- * Display form token for unfiltered comments.
- *
- * Will only display nonce token if the current user has permissions for
- * unfiltered html. Won't display the token for other users.
- *
- * The function was backported to 2.0.10 and was added to versions 2.1.3 and
- * above. Does not exist in versions prior to 2.0.10 in the 2.0 branch and in
- * the 2.1 branch, prior to 2.1.3. Technically added in 2.2.0.
- *
- * Backported to 2.0.10.
- *
- * @since 2.1.3
- */
- function wp_comment_form_unfiltered_html_nonce() {
- $post = get_post();
- $post_id = $post ? $post->ID : 0;
- if ( current_user_can( 'unfiltered_html' ) ) {
- wp_nonce_field( 'unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment_disabled', false );
- echo "<script>(function(){if(window===window.parent){document.getElementById('_wp_unfiltered_html_comment_disabled').name='_wp_unfiltered_html_comment';}})();</script>\n";
- }
- }
- /**
- * Load the comment template specified in $file.
- *
- * Will not display the comments template if not on single post or page, or if
- * the post does not have comments.
- *
- * Uses the WordPress database object to query for the comments. The comments
- * are passed through the 'comments_array' filter hook with the list of comments
- * and the post ID respectively.
- *
- * The $file path is passed through a filter hook called, 'comments_template'
- * which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
- * first and if it fails it will require the default comment template from the
- * default theme. If either does not exist, then the WordPress process will be
- * halted. It is advised for that reason, that the default theme is not deleted.
- *
- * @todo Document globals
- * @uses $withcomments Will not try to get the comments if the post has none.
- *
- * @since 1.5.0
- *
- * @param string $file Optional. The file to load. Default '/comments.php'.
- * @param bool $separate_comments Optional. Whether to separate the comments by comment type. Default false.
- * @return null Returns null if no comments appear.
- */
- function comments_template( $file = '/comments.php', $separate_comments = false ) {
- global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity, $overridden_cpage;
- if ( !(is_single() || is_page() || $withcomments) || empty($post) )
- return;
- if ( empty($file) )
- $file = '/comments.php';
- $req = get_option('require_name_email');
- /**
- * Comment author information fetched from the comment cookies.
- *
- * @uses wp_get_current_commenter()
- */
- $commenter = wp_get_current_commenter();
- /**
- * The name of the current comment author escaped for use in attributes.
- */
- $comment_author = $commenter['comment_author']; // Escaped by sanitize_comment_cookies()
- /**
- * The email address of the current comment author escaped for use in attributes.
- */
- $comment_author_email = $commenter['comment_author_email']; // Escaped by sanitize_comment_cookies()
- /**
- * The url of the current comment author escaped for use in attributes.
- */
- $comment_author_url = esc_url($commenter['comment_author_url']);
- /** @todo Use API instead of SELECTs. */
- if ( $user_ID) {
- $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_gmt", $post->ID, $user_ID));
- } else if ( empty($comment_author) ) {
- $comments = get_comments( array('post_id' => $post->ID, 'status' => 'approve', 'order' => 'ASC') );
- } else {
- $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));
- }
- // keep $comments for legacy's sake
- /**
- * Filter the comments array.
- *
- * @since 2.1.0
- *
- * @param array $comments The array of comments supplied to the comments template.
- * @param int $post->ID The post ID.
- */
- $wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID );
- $comments = &$wp_query->comments;
- $wp_query->comment_count = count($wp_query->comments);
- update_comment_cache($wp_query->comments);
- if ( $separate_comments ) {
- $wp_query->comments_by_type = separate_comments($comments);
- $comments_by_type = &$wp_query->comments_by_type;
- }
- $overridden_cpage = false;
- if ( '' == get_query_var('cpage') && get_option('page_comments') ) {
- set_query_var( 'cpage', 'newest' == get_option('default_comments_page') ? get_comment_pages_count() : 1 );
- $overridden_cpage = true;
- }
- if ( !defined('COMMENTS_TEMPLATE') )
- define('COMMENTS_TEMPLATE', true);
- $theme_template = STYLESHEETPATH . $file;
- /**
- * Filter the path to the theme template file used for the comments template.
- *
- * @since 1.5.1
- *
- * @param string $theme_template The path to the theme template file.
- */
- $include = apply_filters( 'comments_template', $theme_template );
- if ( file_exists( $include ) )
- require( $include );
- elseif ( file_exists( TEMPLATEPATH . $file ) )
- require( TEMPLATEPATH . $file );
- else // Backward compat code will be removed in a future release
- require( ABSPATH . WPINC . '/theme-compat/comments.php');
- }
- /**
- * Display the JS popup script to show a comment.
- *
- * If the $file parameter is empty, then the home page is assumed. The defaults
- * for the window are 400px by 400px.
- *
- * For the comment link popup to work, this function has to be called or the
- * normal comment link will be assumed.
- *
- * @global string $wpcommentspopupfile The URL to use for the popup window.
- * @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called.
- *
- * @since 0.71
- *
- * @param int $width Optional. The width of the popup window. Default 400.
- * @param int $height Optional. The height of the popup window. Default 400.
- * @param string $file Optional. Sets the location of the popup window.
- */
- function comments_popup_script( $width = 400, $height = 400, $file = '' ) {
- global $wpcommentspopupfile, $wpcommentsjavascript;
- if (empty ($file)) {
- $wpcommentspopupfile = ''; // Use the index.
- } else {
- $wpcommentspopupfile = $file;
- }
- $wpcommentsjavascript = 1;
- $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";
- echo $javascript;
- }
- /**
- * Displays the link to the comments popup window for the current post ID.
- *
- * Is not meant to be displayed on single posts and pages. Should be used on the
- * lists of posts
- *
- * @global string $wpcommentspopupfile The URL to use for the popup window.
- * @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called.
- *
- * @since 0.71
- *
- * @param string $zero Optional. The string to display when no comments. Default false.
- * @param string $one Optional. The string to display when only one comment is available. Default false.
- * @param string $more Optional. The string to display when there are more than one comment. Default false.
- * @param string $css_class Optional. The CSS class to use for comments. Default empty.
- * @param string $none Optional. The string to display when comments have been turned off. Default false.
- * @return null Returns null on single posts and pages.
- */
- function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
- global $wpcommentspopupfile, $wpcommentsjavascript;
- $id = get_the_ID();
- if ( false === $zero ) $zero = __( 'No Comments' );
- if ( false === $one ) $one = __( '1 Comment' );
- if ( false === $more ) $more = __( '% Comments' );
- if ( false === $none ) $none = __( 'Comments Off' );
- $number = get_comments_number( $id );
- if ( 0 == $number && !comments_open() && !pings_open() ) {
- echo '<span' . ((!empty($css_class)) ? ' class="' . esc_attr( $css_class ) . '"' : '') . '>' . $none . '</span>';
- return;
- }
- if ( post_password_required() ) {
- echo __('Enter your password to view comments.');
- return;
- }
- echo '<a href="';
- if ( $wpcommentsjavascript ) {
- if ( empty( $wpcommentspopupfile ) )
- $home = home_url();
- else
- $home = get_option('siteurl');
- echo $home . '/' . $wpcommentspopupfile . '?comments_popup=' . $id;
- echo '" onclick="wpopen(this.href); return false"';
- } else { // if comments_popup_script() is not in the template, display simple comment link
- if ( 0 == $number )
- echo get_permalink() . '#respond';
- else
- comments_link();
- echo '"';
- }
- if ( !empty( $css_class ) ) {
- echo ' class="'.$css_class.'" ';
- }
- $title = the_title_attribute( array('echo' => 0 ) );
- $attributes = '';
- /**
- * Filter the comments popup link attributes for display.
- *
- * @since 2.5.0
- *
- * @param string $attributes The comments popup link attributes. Default empty.
- */
- echo apply_filters( 'comments_popup_link_attributes', $attributes );
- echo ' title="' . esc_attr( sprintf( __('Comment on %s'), $title ) ) . '">';
- comments_number( $zero, $one, $more );
- echo '</a>';
- }
- /**
- * Retrieve HTML content for reply to comment link.
- *
- * @since 2.7.0
- *
- * @param array $args {
- * Optional. Override default arguments.
- *
- * @type string 'add_below' The first part of the selector used to identify the comment to respond below. The resulting
- * value is passed as the first parameter to addComment.moveForm(), concatenated
- * as $add_below-$comment->comment_ID. Default 'comment'.
- * @type string 'respond_id' The selector identifying the responding comment. Passed as the third parameter to addComment.moveForm(),
- * and appended to the link URL as a hash value. Default 'respond'.
- * @type string 'reply_text' The text of the Reply link. Default 'Reply'.
- * @type string 'login_text' The text of the link to reply if logged out. Default 'Log in to Reply'.
- * @type int 'depth' The depth of the new comment. Must be greater than 0 and less than the value of the 'thread_comments_depth'
- * option set in Settings > Discussion.
- * Default 0.
- * @type string 'before' The text or HTML to add before the reply link. Default empty.
- * @type string 'after' The text or HTML to add after the reply link. Default empty.
- * }
- * @param int $comment Optional. Comment being replied to. Default current comment.
- * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
- * @return mixed Link to show comment form, if successful. False, if comments are closed.
- */
- function get_comment_reply_link($args = array(), $comment = null, $post = null) {
- $defaults = array(
- 'add_below' => 'comment',
- 'respond_id' => 'respond',
- 'reply_text' => __('Reply'),
- 'login_text' => __('Log in to Reply'),
- 'depth' => 0,
- 'before' => '',
- 'after' => ''
- );
- $args = wp_parse_args($args, $defaults);
- if ( 0 == $args['depth'] || $args['max_depth'] <= $args['depth'] )
- return;
- extract($args, EXTR_SKIP);
- $comment = get_comment($comment);
- if ( empty($post) )
- $post = $comment->comment_post_ID;
- $post = get_post($post);
- if ( !comments_open($post->ID) )
- return false;
- $link = '';
- if ( get_option('comment_registration') && ! is_user_logged_in() )
- $link = '<a rel="nofollow" class="comment-reply-login" href="' . esc_url( wp_login_url( get_permalink() ) ) . '">' . $login_text . '</a>';
- else
- $link = "<a class='comment-reply-link' href='" . esc_url( 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>";
- /**
- * Filter the comment reply link.
- *
- * @since 2.7.0
- *
- * @param string $before Text or HTML displayed before the reply link.
- * @param string $link The HTML markup for the comment reply link.
- * @param string $after Text or HTML displayed after the reply link.
- * @param array $args An array of arguments overriding the defaults.
- * @param object $comment The object of the comment being replied.
- * @param WP_Post $post The WP_Post object.
- */
- return apply_filters( 'comment_reply_link', $before . $link . $after, $args, $comment, $post );
- }
- /**
- * Displays the HTML content for reply to comment link.
- *
- * @since 2.7.0
- *
- * @param array $args Optional. Override default options, @see get_comment_reply_link()
- * @param int $comment Optional. Comment being replied to. Default current comment.
- * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
- * @return mixed Link to show comment form, if successful. False, if comments are closed.
- */
- function comment_reply_link($args = array(), $comment = null, $post = null) {
- echo get_comment_reply_link($args, $comment, $post);
- }
- /**
- * Retrieve HTML content for reply to post link.
- *
- * @since 2.7.0
- *
- * @param array $args {
- * Optional. Override default arguments.
- *
- * @type string 'add_below' The first part of the selector used to identify the comment to respond below.
- * The resulting value is passed as the first parameter to addComment.moveForm(),
- * concatenated as $add_below-$comment->comment_ID. Default is 'post'.
- * @type string 'respond_id' The selector identifying the responding comment. Passed as the third parameter
- * to addComment.moveForm(), and appended to the link URL as a hash value. Default is 'respond'.
- * @type string 'reply_text' The text of the Reply link. Default is 'Leave a Comment'.
- * @type string 'login_text' The text of the link to reply if logged out. Default is 'Log in to leave a Comment'.
- * @type string 'before' The text or HTML to add before the reply link. Default empty.
- * @type string 'after' The text or HTML to add after the reply link. Default empty.
- * }
- * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
- * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
- */
- function get_post_reply_link($args = array(), $post = null) {
- $defaults = array(
- 'add_below' => 'post',
- 'respond_id' => 'respond',
- 'reply_text' => __('Leave a Comment'),
- 'login_text' => __('Log in to leave a Comment'),
- 'before' => '',
- 'after' => '',
- );
- $args = wp_parse_args($args, $defaults);
- extract($args, EXTR_SKIP);
- $post = get_post($post);
- if ( !comments_open($post->ID) )
- return false;
- if ( get_option('comment_registration') && ! is_user_logged_in() )
- $link = '<a rel="nofollow" href="' . wp_login_url( get_permalink() ) . '">' . $login_text . '</a>';
- else
- $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>";
- $formatted_link = $before . $link . $after;
- /**
- * Filter the formatted post comments link HTML.
- *
- * @since 2.7.0
- *
- * @param string $formatted The HTML-formatted post comments link.
- * @param int|WP_Post $post The post ID or WP_Post object.
- */
- return apply_filters( 'post_comments_link', $formatted_link, $post );
- }
- /**
- * Displays the HTML content for reply to post link.
- *
- * @since 2.7.0
- *
- * @param array $args Optional. Override default options, @see get_post_reply_link()
- * @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
- * @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
- */
- function post_reply_link($args = array(), $post = null) {
- echo get_post_reply_link($args, $post);
- }
- /**
- * Retrieve HTML content for cancel comment reply link.
- *
- * @since 2.7.0
- *
- * @param string $text Optional. Text to display for cancel reply link. Default empty.
- */
- function get_cancel_comment_reply_link( $text = '' ) {
- if ( empty($text) )
- $text = __('Click here to cancel reply.');
- $style = isset($_GET['replytocom']) ? '' : ' style="display:none;"';
- $link = esc_html( remove_query_arg('replytocom') ) . '#respond';
- $formatted_link = '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>';
- /**
- * Filter the cancel comment reply link HTML.
- *
- * @since 2.7.0
- *
- * @param string $formatted_link The HTML-formatted cancel comment reply link.
- * @param string $link The cancel comment reply link URL.
- * @param string $text The cancel comment reply link text.
- */
- return apply_filters( 'cancel_comment_reply_link', $formatted_link, $link, $text );
- }
- /**
- * Display HTML content for cancel comment reply link.
- *
- * @since 2.7.0
- *
- * @param string $text Optional. Text to display for cancel reply link. Default empty.
- */
- function cancel_comment_reply_link( $text = '' ) {
- echo get_cancel_comment_reply_link($text);
- }
- /**
- * Retrieve hidden input HTML for replying to comments.
- *
- * @since 3.0.0
- *
- * @param int $id Optional. Post ID. Default current post ID.
- * @return string Hidden input HTML for replying to comments
- */
- function get_comment_id_fields( $id = 0 ) {
- if ( empty( $id ) )
- $id = get_the_ID();
- $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
- $result = "<input type='hidden' name='comment_post_ID' value='$id' id='comment_post_ID' />\n";
- $result .= "<input type='hidden' name='comment_parent' id='comment_parent' value='$replytoid' />\n";
- /**
- * Filter the returned comment id fields.
- *
- * @since 3.0.0
- *
- * @param string $result The HTML-formatted hidden id field comment elements.
- * @param int $id The post ID.
- * @param int $replytoid The id of the comment being replied to.
- */
- return apply_filters( 'comment_id_fields', $result, $id, $replytoid );
- }
- /**
- * Output hidden input HTML for replying to comments.
- *
- * @since 2.7.0
- *
- * @param int $id Optional. Post ID. Default current post ID.
- */
- function comment_id_fields( $id = 0 ) {
- echo get_comment_id_fields( $id );
- }
- /**
- * Display text based on comment reply status.
- *
- * Only affects users with Javascript disabled.
- *
- * @since 2.7.0
- *
- * @param string $noreplytext Optional. Text to display when not replying to a comment. Default false.
- * @param string $replytext Optional. Text to display when replying to a comment.
- * Default false. Accepts "%s" for the author of the comment being replied to.
- * @param string $linktoparent Optional. Boolean to control making the author's name a link to their comment. Default true.
- */
- function comment_form_title( $noreplytext = false, $replytext = false, $linktoparent = true ) {
- global $comment;
- if ( false === $noreplytext ) $noreplytext = __( 'Leave a Reply' );
- if ( false === $replytext ) $replytext = __( 'Leave a Reply to %s' );
- $replytoid = isset($_GET['replytocom']) ? (int) $_GET['replytocom'] : 0;
- if ( 0 == $replytoid )
- echo $noreplytext;
- else {
- $comment = get_comment($replytoid);
- $author = ( $linktoparent ) ? '<a href="#comment-' . get_comment_ID() . '">' . get_comment_author() . '</a>' : get_comment_author();
- printf( $replytext, $author );
- }
- }
- /**
- *