Ticket #7086: comment-template.diff.php

<?php
/**
 * Comment template functions
 *
 * These functions are meant to live inside of the WordPress loop.
 *
 * @package WordPress
 * @subpackage Template
 */

/**
 * get_comment_author() - 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);
}

/**
 * comment_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;
}

/**
 * get_comment_author_email() - 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);
}

/**
 * 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() );
}

/**
 * comment_author_email_link() - 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;
        }
}

/**
 * get_comment_author_link() - 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);
}

/**
 * comment_author_link() - 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();
}

/**
 * get_comment_author_IP() - 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);
}

/**
 * comment_author_IP() - Displays 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();
}

/**
 * get_comment_author_url() - Returns 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);
}

/**
 * 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());
}

/**
 * get_comment_author_url_link() - 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);
}

/**
 * comment_author_url_link() - 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 );
}

/**
 * get_comment_date() - 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);
}

/**
 * comment_date() - 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 );
}

/**
 * get_comment_excerpt() - 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);
}

/**
 * comment_excerpt() - Returns 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() );
}

/**
 * get_comment_ID() - 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);
}

/**
 * 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();
}

/**
 * get_comment_link() - Retrieve the link to the current comment
 *
 * @since 1.5
 * @uses $comment
 *
 * @return string The permalink to the current comment
 */
function get_comment_link() {
        global $comment;
        return get_permalink( $comment->comment_post_ID ) . '#comment-' . $comment->comment_ID;
}

/**
 * get_comments_link() - 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';
}

/**
 * comments_link() - 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();
}

/**
 * get_comments_number() - 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);
}

/**
 * comments_number() - 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);
}

/**
 * get_comment_text() - 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);
}

/**
 * comment_text() - 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() );
}

/**
 * get_comment_time() - 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);
}

/**
 * comment_time() - 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);
}

/**
 * get_comment_type() - 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);
}

/**
 * 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;
        }
}

/**
 * get_trackback_url() - 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);
}

/**
 * trackback_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();
}

/**
 * trackback_rdf() - 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>';
        }
}

/**
 * comments_open() - 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 );
}

/**
 * pings_open() - 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 );
}

/**
 * wp_comment_form_unfiltered_html_nonce() - 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);
}

/**
 * comments_template() - 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 default theme is not deleted.
 *
 * @since 1.5
 * @global array $comment List of comment objects for the current post
 * @uses $wpdb
 * @uses $id
 * @uses $post
 * @uses $withcomments Will not try to get the comments if the post has none.
 *
 * @param string $file Optional, default '/comments.php'. The file to load
 * @return null Returns null if no comments appear
 */
function comments_template( $file = '/comments.php' ) {
        global $wp_query, $withcomments, $post, $wpdb, $id, $comment, $user_login, $user_ID, $user_identity;

        if ( ! (is_single() || is_page() || $withcomments) )
                return;

        $req = get_option('require_name_email');
        $commenter = wp_get_current_commenter();
        extract($commenter, EXTR_SKIP);

        /** @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", $post->ID, $user_ID));
        } else if ( empty($comment_author) ) {
                $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));
        } 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", $post->ID, $comment_author, $comment_author_email));
        }

        // keep $comments for legacy's sake (remember $table*? ;) )
        $comments = $wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID );
        $wp_query->comment_count = count($wp_query->comments);
        update_comment_cache($comments);

        define('COMMENTS_TEMPLATE', true);
        $include = apply_filters('comments_template', STYLESHEETPATH . $file );
        if (file_exists( $include ) )
                require( $include );

        //not sure if this is needed - KKWangen
        elseif( TEMPLATEPATH == STYLESHEETPATH && file_exists(TEMPLATEPATH . $file) )
                require( TEMPLATEPATH . $file );

        else
                require( WP_CONTENT_DIR . '/themes/default/comments.php');
}

/**
 * comments_popup_script() - Displays 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.
 *
 * @since 0.71
 * @global string $wpcommentspopupfile The URL to use for the popup window
 * @global int $wpcommentsjavascript Whether to use JavaScript or not. Set when function is called
 *
 * @param int $width Optional. The width of the popup window
 * @param int $height Optional. The height of the popup window
 * @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;
}

/**
 * comments_popup_link() - 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
 *
 * @since 0.71
 * @uses $id
 * @uses $wpcommentspopupfile
 * @uses $wpcommentsjavascript
 * @uses $post
 *
 * @param string $zero The string to display when no comments
 * @param string $one The string to display when only one comment is available
 * @param string $more The string to display when there are more than one comment
 * @param string $css_class The CSS class to use for comments
 * @param string $none The string to display when comments have been turned off
 * @return null Returns null on single posts and pages.
 */
function comments_popup_link( $zero = 'No Comments', $one = '1 Comment', $more = '% Comments', $css_class = '', $none = 'Comments Off' ) {
        global $id, $wpcommentspopupfile, $wpcommentsjavascript, $post;

        if ( is_single() || is_page() )
                return;

        $number = get_comments_number( $id );

        if ( 0 == $number && 'closed' == $post->comment_status && 'closed' == $post->ping_status ) {
                echo '<span' . ((!empty($css_class)) ? ' class="' . $css_class . '"' : '') . '>' . $none . '</span>';
                return;
        }

        if ( !empty($post->post_password) ) { // if there's a password
                if ( !isset($_COOKIE['wp-postpass_' . COOKIEHASH]) || $_COOKIE['wp-postpass_' . COOKIEHASH] != $post->post_password ) {  // and it doesn't match the cookie
                        echo __('Enter your password to view comments');
                        return;
                }
        }

        echo '<a href="';
        if ( $wpcommentsjavascript ) {
                if ( empty( $wpcommentspopupfile ) )
                        $home = get_option('home');
                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 = attribute_escape( get_the_title() );

        echo apply_filters( 'comments_popup_link_attributes', '' );

        echo ' title="' . sprintf( __('Comment on %s'), $title ) . '">';
        comments_number( $zero, $one, $more, $number );
        echo '</a>';
}

?>