Index: comment-template.php =================================================================== --- comment-template.php (revision 6492) +++ comment-template.php (working copy) @@ -1,8 +1,24 @@ comment_author) ) @@ -12,20 +28,62 @@ 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); @@ -37,7 +95,16 @@ } } +/** + * 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(); @@ -48,28 +115,81 @@ 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; @@ -81,10 +201,30 @@ 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 ) @@ -94,10 +234,30 @@ 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); @@ -117,32 +277,85 @@ 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 $file Not Used + * @param bool $echo Not Used + */ function comments_link( $file = '', $echo = true ) { - echo get_comments_link(); + 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 ) { $post_id = (int) $post_id; @@ -158,6 +371,18 @@ 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); @@ -172,15 +397,41 @@ 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; @@ -191,10 +442,26 @@ 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; @@ -204,6 +471,15 @@ 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 ) { @@ -218,6 +494,19 @@ } } +/** + * 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') ) { @@ -228,11 +517,27 @@ return apply_filters('trackback_url', $tb_url); } -function trackback_url($deprecated = true) { // remove backwards compat in 2.4 +/** + * 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.4 + * @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 $timezone Not used + */ function trackback_rdf($timezone = 0) { if (stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') === false) { echo 'comment_status ) @@ -258,6 +571,14 @@ return false; } +/** + * pings_open() - Whether the current post is open for pings + * + * @since 1.5 + * @uses $post + * + * @return bool True if pings are accepted + */ function pings_open() { global $post; if ( 'open' == $post->ping_status ) @@ -266,12 +587,52 @@ return false; } +/** + * 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; @@ -282,7 +643,7 @@ $commenter = wp_get_current_commenter(); extract($commenter, EXTR_SKIP); - // TODO: Use API instead of SELECTs. + /** @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) ) { @@ -304,20 +665,55 @@ require( ABSPATH . 'wp-content/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; + global $wpcommentspopupfile, $wpcommentsjavascript; - if (empty ($file)) { - $wpcommentspopupfile = ''; // Use the index. - } else { - $wpcommentspopupfile = $file; - } + if (empty ($file)) { + $wpcommentspopupfile = ''; // Use the index. + } else { + $wpcommentspopupfile = $file; + } - $wpcommentsjavascript = 1; - $javascript = "\n"; - echo $javascript; + $wpcommentsjavascript = 1; + $javascript = "\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; @@ -366,4 +762,4 @@ echo ''; } -?> +?> \ No newline at end of file