root/trunk/wp-includes/comment-template.php

<?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
 * @uses apply_filters() Calls 'get_comment_author' hook on the comment author
 *
 * @return string The comment author
 */
function get_comment_author() {
    global $comment;
    if ( empty($comment->comment_author) )
        $author = __('Anonymous');
    else
        $author = $comment->comment_author;
    return apply_filters('get_comment_author', $author);
}

/**
 * Displays the author of the current comment.
 *
 * @since 0.71
 * @uses apply_filters() Calls 'comment_author' on comment author before displaying
 */
function comment_author() {
    $author = apply_filters('comment_author', get_comment_author() );
    echo $author;
}

/**
 * Retrieve the email of the author of the current comment.
 *
 * @since 1.5
 * @uses apply_filters() Calls the 'get_comment_author_email' hook on the comment author email
 * @uses $comment
 *
 * @return string The current comment author's email
 */
function get_comment_author_email() {
    global $comment;
    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
 * @uses apply_filters() Calls 'author_email' hook on the author email
 */
function comment_author_email() {
    echo apply_filters('author_email', get_comment_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.
 *
 * @since 0.71
 * @uses apply_filters() Calls 'comment_email' hook for the display of the comment author's email
 * @global object $comment The current Comment row object
 *
 * @param string $linktext The text to display instead of the comment author's email address
 * @param string $before The text or HTML to display before the email link.
 * @param string $after The text or HTML to display after the email link.
 */
function comment_author_email_link($linktext='', $before='', $after='') {
    global $comment;
    $email = apply_filters('comment_email', $comment->comment_author_email);
    if ((!empty($email)) && ($email != '@')) {
    $display = ($linktext != '') ? $linktext : $email;
        echo $before;
        echo "<a href='mailto:$email'>$display</a>";
        echo $after;
    }
}

/**
 * Retrieve the html link to the url of the author of the current comment.
 *
 * @since 1.5
 * @uses apply_filters() Calls 'get_comment_author_link' hook on the complete link HTML or author
 *
 * @return string Comment Author name or HTML link for author's URL
 */
function get_comment_author_link() {
    /** @todo Only call these functions when they are needed. Include in if... else blocks */
    $url    = get_comment_author_url();
    $author = get_comment_author();

    if ( empty( $url ) || 'http://' == $url )
        $return = $author;
    else
        $return = "<a href='$url' rel='external nofollow'>$author</a>";
    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() Echos result
 */
function comment_author_link() {
    echo get_comment_author_link();
}

/**
 * Retrieve the IP address of the author of the current comment.
 *
 * @since 1.5
 * @uses $comment
 * @uses apply_filters()
 *
 * @return unknown
 */
function get_comment_author_IP() {
    global $comment;
    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
 * @see get_comment_author_IP() Echos Result
 */
function comment_author_IP() {
    echo get_comment_author_IP();
}

/**
 * Retrieve the url of the author of the current comment.
 *
 * @since 1.5
 * @uses apply_filters() Calls 'get_comment_author_url' hook on the comment author's URL
 *
 * @return string
 */
function get_comment_author_url() {
    global $comment;
    return apply_filters('get_comment_author_url', $comment->comment_author_url);
}

/**
 * Display the url of the author of the current comment.
 *
 * @since 0.71
 * @uses apply_filters()
 * @uses get_comment_author_url() Retrieves the comment author's URL
 */
function comment_author_url() {
    echo apply_filters('comment_url', get_comment_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
 * @uses apply_filters() Calls the 'get_comment_author_url_link' on the complete HTML before returning.
 *
 * @param string $linktext The text to display instead of the comment author's email address
 * @param string $before The text or HTML to display before the email link.
 * @param string $after The text or HTML to display after the email link.
 * @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";
    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
 * @see get_comment_author_url_link() Echos result
 *
 * @param string $linktext The text to display instead of the comment author's email address
 * @param string $before The text or HTML to display before the email link.
 * @param string $after The text or HTML to display after the email link.
 */
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
 *
 * @param string|array $class One or more classes to add to the class list
 * @param int $comment_id An optional comment ID
 * @param int $post_id An optional post ID
 */
function comment_class( $class = '', $comment_id = null, $post_id = null ) {
    // Separates classes with a single space, collates classes for post DIV
    echo 'class="' . join( ' ', get_comment_class( $class, $comment_id, $post_id ) ) . '"';
}

/**
 * Returns the classes for the comment div as an array
 *
 * @since 2.7
 *
 * @param string|array $class One or more classes to add to the class list
 * @param int $comment_id An optional comment ID
 * @param int $post_id An optional post ID
 * @return array Array of classes
 */
function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
    static $comment_alt;

    $comment = get_comment($comment_id);

    $classes = array();

    // Get the comment type (comment, trackback),
    $classes[] = $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 comment-author-' . $user->user_nicename;
        // 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 ( $comment_alt % 2 )
        $classes[] = 'odd';
    else
        $classes[] = 'even';

    $comment_alt++;

    if ( !empty($class) ) {
        if ( !is_array( $class ) )
            $class = preg_split('#\s+#', $class);
        $classes = array_merge($classes, $class);
    }

    return apply_filters('comment_class', $classes, $class, $comment_id, $post_id);
}

/**
 * Retrieve the comment date of the current comment.
 *
 * @since 1.5
 * @uses apply_filters() Calls 'get_comment_date' hook with the formated date and the $d parameter respectively
 * @uses $comment
 *
 * @param string $d The format of the date (defaults to user's config)
 * @return string The comment's date
 */
function get_comment_date( $d = '' ) {
    global $comment;
    if ( '' == $d )
        $date = mysql2date( get_option('date_format'), $comment->comment_date);
    else
        $date = mysql2date($d, $comment->comment_date);
    return apply_filters('get_comment_date', $date, $d);
}

/**
 * Display the comment date of the current comment.
 *
 * @since 0.71
 *
 * @param string $d The format of the date (defaults to user's config)
 */
function comment_date( $d = '' ) {
    echo get_comment_date( $d );
}

/**
 * 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
 * @uses $comment
 * @uses apply_filters() Calls 'get_comment_excerpt' on truncated comment
 *
 * @return string The maybe truncated comment with 20 words or less
 */
function get_comment_excerpt() {
    global $comment;
    $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
 * @uses apply_filters() Calls 'comment_excerpt' hook before displaying excerpt
 */
function comment_excerpt() {
    echo apply_filters('comment_excerpt', get_comment_excerpt() );
}

/**
 * Retrieve the comment id of the current comment.
 *
 * @since 1.5
 * @uses $comment
 * @uses apply_filters() Calls the 'get_comment_ID' hook for the comment ID
 *
 * @return int The comment ID
 */
function get_comment_ID() {
    global $comment;
    return apply_filters('get_comment_ID', $comment->comment_ID);
}

/**
 * Displays the comment id of the current comment.
 *
 * @since 0.71
 * @see get_comment_ID() Echos Result
 */
function comment_ID() {
    echo get_comment_ID();
}

/**
 * Retrieve the link to the current comment.
 *
 * @since 1.5
 * @uses $comment
 *
 * @param object|string|int $comment Comment to retrieve.
 * @return string The permalink to the current comment
 */
function get_comment_link($comment = null) {
    $comment = get_comment($comment);
    return get_permalink( $comment->comment_post_ID ) . '#comment-' . $comment->comment_ID;
}

/**
 * Retrieves the link to the current post comments.
 *
 * @since 1.5
 *
 * @return string The link to the comments
 */
function get_comments_link() {
    return get_permalink() . '#comments';
}

/**
 * Displays the link to the current post comments.
 *
 * @since 0.71
 *
 * @param string $deprecated Not Used
 * @param bool $deprecated Not Used
 */
function comments_link( $deprecated = '', $deprecated = '' ) {
    echo get_comments_link();
}

/**
 * Retrieve the amount of comments a post has.
 *
 * @since 1.5
 * @uses apply_filters() Calls the 'get_comments_number' hook on the number of comments
 *
 * @param int $post_id The Post ID
 * @return int The number of comments a post has
 */
function get_comments_number( $post_id = 0 ) {
    global $id;
    $post_id = (int) $post_id;

    if ( !$post_id )
        $post_id = (int) $id;

    $post = get_post($post_id);
    if ( ! isset($post->comment_count) )
        $count = 0;
    else
        $count = $post->comment_count;

    return apply_filters('get_comments_number', $count);
}

/**
 * Display the language string for the number of comments the current post has.
 *
 * @since 0.71
 * @uses $id
 * @uses apply_filters() Calls the 'comments_number' hook on the output and number of comments respectively.
 *
 * @param string $zero Text for no comments
 * @param string $one Text for one comment
 * @param string $more Text for more than one comment
 * @param string $deprecated Not used.
 */
function comments_number( $zero = false, $one = false, $more = false, $deprecated = '' ) {
    global $id;
    $number = get_comments_number($id);

    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;

    echo apply_filters('comments_number', $output, $number);
}

/**
 * Retrieve the text of the current comment.
 *
 * @since 1.5
 * @uses $comment
 *
 * @return string The comment content
 */
function get_comment_text() {
    global $comment;
    return apply_filters('get_comment_text', $comment->comment_content);
}

/**
 * Displays the text of the current comment.
 *
 * @since 0.71
 * @uses apply_filters() Passes the comment content through the 'comment_text' hook before display
 * @uses get_comment_text() Gets the comment content
 */
function comment_text() {
    echo apply_filters('comment_text', get_comment_text() );
}

/**
 * Retrieve the comment time of the current comment.
 *
 * @since 1.5
 * @uses $comment
 * @uses apply_filter() Calls 'get_comment_time' hook with the formatted time, the $d parameter, and $gmt parameter passed.
 *
 * @param string $d Optional. The format of the time (defaults to user's config)
 * @param bool $gmt Whether to use the GMT date
 * @return string The formatted time
 */
function get_comment_time( $d = '', $gmt = false ) {
    global $comment;
    $comment_date = $gmt? $comment->comment_date_gmt : $comment->comment_date;
    if ( '' == $d )
        $date = mysql2date(get_option('time_format'), $comment_date);
    else
        $date = mysql2date($d, $comment_date);
    return apply_filters('get_comment_time', $date, $d, $gmt);
}

/**
 * Display the comment time of the current comment.
 *
 * @since 0.71
 *
 * @param string $d Optional. The format of the time (defaults to user's config)
 */
function comment_time( $d = '' ) {
    echo get_comment_time($d);
}

/**
 * Retrieve the comment type of the current comment.
 *
 * @since 1.5
 * @uses $comment
 * @uses apply_filters() Calls the 'get_comment_type' hook on the comment type
 *
 * @return string The comment type
 */
function get_comment_type() {
    global $comment;

    if ( '' == $comment->comment_type )
        $comment->comment_type = 'comment';

    return apply_filters('get_comment_type', $comment->comment_type);
}

/**
 * Display the comment type of the current comment.
 *
 * @since 0.71
 *
 * @param string $commenttxt The string to display for comment type
 * @param string $trackbacktxt The string to display for trackback type
 * @param string $pingbacktxt The string to display for pingback type
 */
function comment_type($commenttxt = 'Comment', $trackbacktxt = 'Trackback', $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
 * @uses apply_filters() Calls 'trackback_url' on the resulting trackback URL
 * @uses $id
 *
 * @return string The trackback URL after being filtered
 */
function get_trackback_url() {
    global $id;
    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=' . $id;
    }
    return apply_filters('trackback_url', $tb_url);
}

/**
 * Displays the current post's trackback URL.
 *
 * @since 0.71
 * @uses get_trackback_url() Gets the trackback url for the current post
 *
 * @param bool $deprecated Remove backwards compat in 2.5
 * @return void|string Should only be used to echo the trackback URL, use get_trackback_url() for the result instead.
 */
function trackback_url($deprecated = true) {
    if ($deprecated) echo get_trackback_url();
    else return get_trackback_url();
}

/**
 * Generates and displays the RDF for the trackback information of current post.
 *
 * @since 0.71
 *
 * @param int $deprecated Not used (Was $timezone = 0)
 */
function trackback_rdf($deprecated = '') {
    if (stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') === false) {
        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('--', '&#x2d;&#x2d;', 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
 * @uses $post
 *
 * @param int $post_id An optional post ID to check instead of the 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 );
    return apply_filters( 'comments_open', $open, $post_id );
}

/**
 * Whether the current post is open for pings.
 *
 * @since 1.5
 * @uses $post
 *
 * @param int $post_id An optional post ID to check instead of the 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 );
}

/**
 * Displays 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.
 *
 * @since 2.0.10 Backported to 2.0 branch
 * @since 2.1.3
 * @uses $post Gets the ID of the current post for the token
 */
function wp_comment_form_unfiltered_html_nonce() {
    global $post;
    if ( current_user_can('unfiltered_html') )
        wp_nonce_field('unfiltered-html-comment_' . $post->ID, '_wp_unfiltered_html_comment', false);
}

/**
 * Loads 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 themplate from the
 * default theme. If either does not exist, then the WordPress process will be
 * halted. It is advised for that reason, that the defa