Changeset 6495

Timestamp:

12/26/07 17:18:13 (1 year ago)

Author:

ryan

Message:

phpdoc for comment-template.php from darkdragon. fixes #5528

Files:

• trunk/wp-includes/comment-template.php (modified) (26 diffs)

trunk/wp-includes/comment-template.php

@@ -1 +1 @@
-<?php
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function get_comment_author() {
-    global $comment;
@@ -13 +29 @@
-}
-
+/**
+ * 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() );
@@ -18 +40 @@
-}
-
+/**
+ * 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;
@@ -23 +54 @@
-}
-
+/**
+ * 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;
@@ -38 +96 @@
-}
-
+/**
+ * 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();
@@ -49 +116 @@
-}
-
+/**
+ * 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;
@@ -58 +140 @@
-}
-
+/**
+ * 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;
@@ -67 +163 @@
-}
-
+/**
+ * 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();
@@ -82 +202 @@
-}
-
+/**
+ * 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;
@@ -95 +235 @@
-}
-
+/**
+ * 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;
@@ -118 +278 @@
-}
-
+/**
+ * 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;
@@ -127 +302 @@
-}
-
+/**
+ * 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;
@@ -136 +325 @@
-}
-
+/**
+ * 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 ) {
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-function get_comments_number( $post_id = 0 ) {
-    $post_id = (int) $post_id;
@@ -159 +372 @@
-}
-
+/**
+ * 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;
@@ -173 +398 @@
-}
-
+/**
+ * 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;
@@ -178 +411 @@
-}
-
+/**
+ * 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;
@@ -192 +443 @@
-}
-
+/**
+ * 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;
@@ -205 +472 @@
-}
-
+/**
+ * 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();
@@ -219 +495 @@
-}
-
+/**
+ * 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;
@@ -229 +518 @@
-}
-
-
+
+
+
+
+
+
+
+
+
+
-    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) {
@@ -251 +556 @@
-}
-
+/**
+ * comments_open() - Whether the current post is open for comments
+ *
+ * @since 1.5
+ * @uses $post
+ *
+ * @return bool True if the comments are open
+ */
-function comments_open() {
-    global $post;
@@ -259 +572 @@
-}
-
+/**
+ * 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;
@@ -267 +588 @@
-}
-
+/**
+ * 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;
@@ -273 +608 @@
-}
-
+/**
+ * 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;
@@ -283 +644 @@
-    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));
@@ -305 +666 @@
-}
-
+/**
+ * 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='') {
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-function comments_popup_link( $zero = 'No Comments', $one = '1 Comment', $more = '% Comments', $css_class = '', $none = 'Comments Off' ) {
-    global $id, $wpcommentspopupfile, $wpcommentsjavascript, $post;