X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/177fd6fefd2e3d5a0ea6591c71d660cabdb3c1a4..03f2fa83c13c1b532284205fa7efcab9b8b2c41f:/wp-includes/comment-template.php
diff --git a/wp-includes/comment-template.php b/wp-includes/comment-template.php
index 6e2ec62d..ada53c89 100644
--- a/wp-includes/comment-template.php
+++ b/wp-includes/comment-template.php
@@ -9,479 +9,1038 @@
*/
/**
- * get_comment_author() - Retrieve the author of the current comment
+ * Retrieve the author of the current comment.
*
- * If the comment has an empty comment_author field, then 'Anonymous' person
- * is assumed.
+ * 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
+ * @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to retrieve the author.
+ * Default current comment.
* @return string The comment author
*/
-function get_comment_author() {
- global $comment;
- if ( empty($comment->comment_author) )
- $author = __('Anonymous');
- else
+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;
- return apply_filters('get_comment_author', $author);
+ }
+
+ /**
+ * Filter the returned comment author name.
+ *
+ * @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
+ *
+ * @param string $author The comment author's username.
+ * @param int $comment_ID The comment ID.
+ * @param WP_Comment $comment The comment object.
+ */
+ return apply_filters( 'get_comment_author', $author, $comment->comment_ID, $comment );
}
/**
- * comment_author() - Displays the author of the current comment
+ * Displays the author of the current comment.
*
* @since 0.71
- * @uses apply_filters() Calls 'comment_author' on comment author before displaying
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
+ *
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author.
+ * Default current comment.
*/
-function comment_author() {
- $author = apply_filters('comment_author', get_comment_author() );
- echo $author;
+function comment_author( $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
+ $author = get_comment_author( $comment );
+
+ /**
+ * Filter the comment author's name for display.
+ *
+ * @since 1.2.0
+ * @since 4.1.0 The `$comment_ID` parameter was added.
+ *
+ * @param string $author The comment author's username.
+ * @param int $comment_ID The comment ID.
+ */
+ echo apply_filters( 'comment_author', $author, $comment->comment_ID );
}
/**
- * get_comment_author_email() - Retrieve the email of the author of the current comment
+ * 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
+ * @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or 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() {
- global $comment;
- return apply_filters('get_comment_author_email', $comment->comment_author_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
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
+ *
+ * @param string $comment_author_email The comment author's email address.
+ * @param int $comment_ID The comment ID.
+ * @param WP_Comment $comment The comment object.
+ */
+ return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment->comment_ID, $comment );
}
/**
- * comment_author_email() - Display the email of the author of the current global $comment
+ * 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.
+ * 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
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
+ *
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's email.
+ * Default current comment.
*/
-function comment_author_email() {
- echo apply_filters('author_email', get_comment_author_email() );
+function comment_author_email( $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
+ $author_email = get_comment_author_email( $comment );
+
+ /**
+ * Filter the comment author's email for display.
+ *
+ * @since 1.2.0
+ * @since 4.1.0 The `$comment_ID` parameter was added.
+ *
+ * @param string $author_email The comment author's email address.
+ * @param int $comment_ID The comment ID.
+ */
+ echo apply_filters( 'author_email', $author_email, $comment->comment_ID );
}
/**
- * comment_author_email_link() - Display the html email link to the author of the current comment
+ * 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.
+ * 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.
+ * @param string $linktext Optional. Text to display instead of the comment author's email address.
+ * Default empty.
+ * @param string $before Optional. Text or HTML to display before the email link. Default empty.
+ * @param string $after Optional. Text or HTML to display after the email link. Default empty.
*/
-function comment_author_email_link($linktext='', $before='', $after='') {
- global $comment;
- $email = apply_filters('comment_email', $comment->comment_author_email);
+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.
+ *
+ * @since 2.7.0
+ *
+ * @param string $linktext Optional. Text to display instead of the comment author's email address.
+ * Default empty.
+ * @param string $before Optional. Text or HTML to display before the email link. Default empty.
+ * @param string $after Optional. Text or HTML to display after the email link. Default empty.
+ * @return string
+ */
+function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
+ $comment = get_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 commenter's email address.
+ *
+ * @since 1.2.0
+ * @since 4.1.0 The `$comment` parameter was added.
+ *
+ * @param string $comment_author_email The comment author's email address.
+ * @param WP_Comment $comment The comment object.
+ */
+ $email = apply_filters( 'comment_email', $comment->comment_author_email, $comment );
if ((!empty($email)) && ($email != '@')) {
$display = ($linktext != '') ? $linktext : $email;
- echo $before;
- echo "$display";
- echo $after;
+ $return = $before;
+ $return .= sprintf( '%2$s', esc_url( 'mailto:' . $email ), esc_html( $display ) );
+ $return .= $after;
+ return $return;
+ } else {
+ return '';
}
}
/**
- * get_comment_author_link() - Retrieve the html link to the url of the author of the current comment
+ * 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
+ * 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.
*
- * @return string Comment Author name or HTML link for author's URL
+ * @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
+ *
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or 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() {
- /** @todo Only call these functions when they are needed. Include in if... else blocks */
- $url = get_comment_author_url();
- $author = get_comment_author();
+function get_comment_author_link( $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
+ $url = get_comment_author_url( $comment );
+ $author = get_comment_author( $comment );
if ( empty( $url ) || 'http://' == $url )
$return = $author;
else
- $return = "$author";
- return apply_filters('get_comment_author_link', $return);
+ $return = "$author";
+
+ /**
+ * Filter the comment author's link for display.
+ *
+ * @since 1.5.0
+ * @since 4.1.0 The `$author` and `$comment_ID` parameters were added.
+ *
+ * @param string $return The HTML-formatted comment author link.
+ * Empty for an invalid URL.
+ * @param string $author The comment author's username.
+ * @param int $comment_ID The comment ID.
+ */
+ return apply_filters( 'get_comment_author_link', $return, $author, $comment->comment_ID );
}
/**
- * comment_author_link() - Display the html link to the url of the author of the current comment
+ * Display the html link to the url of the author of the current comment.
*
* @since 0.71
- * @see get_comment_author_link() Echos result
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
+ *
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's link.
+ * Default current comment.
*/
-function comment_author_link() {
- echo get_comment_author_link();
+function comment_author_link( $comment_ID = 0 ) {
+ echo get_comment_author_link( $comment_ID );
}
/**
- * get_comment_author_IP() - Retrieve the IP address of the author of the current comment
+ * Retrieve the IP address of the author of the current comment.
*
- * @since 1.5
- * @uses $comment
- * @uses apply_filters()
+ * @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @return unknown
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's IP address.
+ * Default current comment.
+ * @return string Comment author's IP address.
*/
-function get_comment_author_IP() {
- global $comment;
- return apply_filters('get_comment_author_IP', $comment->comment_author_IP);
+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
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
+ *
+ * @param string $comment_author_IP The comment author's IP address.
+ * @param int $comment_ID The comment ID.
+ * @param WP_Comment $comment The comment object.
+ */
+ return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment->comment_ID, $comment );
}
/**
- * comment_author_IP() - Displays the IP address of the author of the current comment
+ * Display the IP address of the author of the current comment.
*
* @since 0.71
- * @see get_comment_author_IP() Echos Result
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
+ *
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's IP address.
+ * Default current comment.
*/
-function comment_author_IP() {
- echo get_comment_author_IP();
+function comment_author_IP( $comment_ID = 0 ) {
+ echo esc_html( get_comment_author_IP( $comment_ID ) );
}
/**
- * get_comment_author_url() - Returns the url of the author of the current comment
+ * 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
+ * @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @return string
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's URL.
+ * Default current comment.
+ * @return string Comment author URL.
*/
-function get_comment_author_url() {
- global $comment;
- return apply_filters('get_comment_author_url', $comment->comment_author_url);
+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
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
+ *
+ * @param string $url The comment author's URL.
+ * @param int $comment_ID The comment ID.
+ * @param WP_Comment $comment The comment object.
+ */
+ return apply_filters( 'get_comment_author_url', $url, $comment->comment_ID, $comment );
}
/**
- * comment_author_url() - Display the url of the author of the current comment
+ * 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
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
+ *
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's URL.
+ * Default current comment.
*/
-function comment_author_url() {
- echo apply_filters('comment_url', get_comment_author_url());
+function comment_author_url( $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
+ $author_url = get_comment_author_url( $comment );
+
+ /**
+ * Filter the comment author's URL for display.
+ *
+ * @since 1.2.0
+ * @since 4.1.0 The `$comment_ID` parameter was added.
+ *
+ * @param string $author_url The comment author's URL.
+ * @param int $comment_ID The comment ID.
+ */
+ echo apply_filters( 'comment_url', $author_url, $comment->comment_ID );
}
/**
- * get_comment_author_url_link() - Retrieves the HTML link of the url of the author of the current comment
+ * 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.
+ * $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.
+ * 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.
+ * @since 1.5.0
*
- * @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
+ * @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) )
+
+ if ( '/' == substr($display, -1) ) {
$display = substr($display, 0, -1);
+ }
+
$return = "$before$display$after";
- return apply_filters('get_comment_author_url_link', $return);
+
+ /**
+ * 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 );
}
/**
- * comment_author_url_link() - Displays the HTML link of the url of the author of the current comment
+ * 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.
+ * @param string $linktext Optional. Text to display instead of the comment author's
+ * email address. Default empty.
+ * @param string $before Optional. Text or HTML to display before the email link.
+ * Default empty.
+ * @param string $after Optional. 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 );
}
/**
- * get_comment_date() - Retrieve the comment date of the current comment
+ * Generates semantic classes for each comment element.
+ *
+ * @since 2.7.0
+ * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
+ *
+ * @param string|array $class Optional. One or more classes to add to the class list.
+ * Default empty.
+ * @param int|WP_Comment $comment Comment ID or WP_Comment object. Default current comment.
+ * @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
+ * @param bool $echo Optional. Whether to cho or return the output.
+ * Default true.
+ * @return string If `$echo` is false, the class will be returned. Void otherwise.
+ */
+function comment_class( $class = '', $comment = 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, $post_id ) ) . '"';
+ if ( $echo)
+ echo $class;
+ else
+ return $class;
+}
+
+/**
+ * Returns the classes for the comment div as an array.
+ *
+ * @since 2.7.0
+ * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object.
+ *
+ * @global int $comment_alt
+ * @global int $comment_depth
+ * @global int $comment_thread_alt
+ *
+ * @param string|array $class Optional. One or more classes to add to the class list. Default empty.
+ * @param int|WP_Comment $comment_id Comment ID or WP_Comment object. Default current comment.
+ * @param int|WP_Post $post_id 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;
+
+ $classes = array();
+
+ $comment = get_comment( $comment_id );
+ if ( ! $comment ) {
+ return $classes;
+ }
+
+ // Get the comment type (comment, trackback),
+ $classes[] = ( empty( $comment->comment_type ) ) ? 'comment' : $comment->comment_type;
+
+ // Add classes for comment authors that are registered users.
+ if ( $comment->user_id > 0 && $user = get_userdata( $comment->user_id ) ) {
+ $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 WP_Comment $comment The comment object.
+ * @param int|WP_Post $post_id The post ID or WP_Post object.
+ */
+ return apply_filters( 'comment_class', $classes, $class, $comment->comment_ID, $comment, $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
+ * @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param string $d The format of the date (defaults to user's config)
- * @return string The comment's date
+ * @param string $d Optional. The format of the date. Default user's setting.
+ * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the date.
+ * Default current comment.
+ * @return string The comment's date.
*/
-function get_comment_date( $d = '' ) {
- global $comment;
+function get_comment_date( $d = '', $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
if ( '' == $d )
- $date = mysql2date( get_option('date_format'), $comment->comment_date);
+ $date = mysql2date(get_option('date_format'), $comment->comment_date);
else
$date = mysql2date($d, $comment->comment_date);
- return apply_filters('get_comment_date', $date, $d);
+ /**
+ * 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.
+ * @param WP_Comment $comment The comment object.
+ */
+ return apply_filters( 'get_comment_date', $date, $d, $comment );
}
/**
- * comment_date() - Display the comment date of the current comment
+ * Display the comment date of the current comment.
*
* @since 0.71
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @param string $d The format of the date (defaults to user's config)
+ * @param string $d Optional. The format of the date. Default user's settings.
+ * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the date.
+ * Default current comment.
*/
-function comment_date( $d = '' ) {
- echo get_comment_date( $d );
+function comment_date( $d = '', $comment_ID = 0 ) {
+ echo get_comment_date( $d, $comment_ID );
}
/**
- * get_comment_excerpt() - Retrieve the excerpt of the current comment
+ * 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 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
+ * @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @return string The maybe truncated comment with 20 words or less
+ * @param int|WP_Comment $comment_ID WP_Comment or 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() {
- 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;
+function get_comment_excerpt( $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
+ $comment_text = strip_tags( str_replace( array( "\n", "\r" ), ' ', $comment->comment_content ) );
+ $words = explode( ' ', $comment_text );
+
+ /**
+ * Filter the amount of words used in the comment excerpt.
+ *
+ * @since 4.4.0
+ *
+ * @param int $comment_excerpt_length The amount of words you want to display in the comment excerpt.
+ */
+ $comment_excerpt_length = apply_filters( 'comment_excerpt_length', 20 );
+
+ $use_ellipsis = count( $words ) > $comment_excerpt_length;
+ if ( $use_ellipsis ) {
+ $words = array_slice( $words, 0, $comment_excerpt_length );
}
- $excerpt = '';
- for ($i=0; $i<$k; $i++) {
- $excerpt .= $blah[$i] . ' ';
+
+ $excerpt = trim( join( ' ', $words ) );
+ if ( $use_ellipsis ) {
+ $excerpt .= '…';
}
- $excerpt .= ($use_dotdotdot) ? '...' : '';
- return apply_filters('get_comment_excerpt', $excerpt);
+ /**
+ * Filter the retrieved comment excerpt.
+ *
+ * @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
+ *
+ * @param string $excerpt The comment excerpt text.
+ * @param int $comment_ID The comment ID.
+ * @param WP_Comment $comment The comment object.
+ */
+ return apply_filters( 'get_comment_excerpt', $excerpt, $comment->comment_ID, $comment );
}
/**
- * comment_excerpt() - Returns the excerpt of the current comment
+ * Display the excerpt of the current comment.
*
- * @since 1.2
- * @uses apply_filters() Calls 'comment_excerpt' hook before displaying excerpt
+ * @since 1.2.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
+ *
+ * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the excerpt.
+ * Default current comment.
*/
-function comment_excerpt() {
- echo apply_filters('comment_excerpt', get_comment_excerpt() );
+function comment_excerpt( $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
+ $comment_excerpt = get_comment_excerpt( $comment );
+
+ /**
+ * Filter the comment excerpt for display.
+ *
+ * @since 1.2.0
+ * @since 4.1.0 The `$comment_ID` parameter was added.
+ *
+ * @param string $comment_excerpt The comment excerpt text.
+ * @param int $comment_ID The comment ID.
+ */
+ echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment->comment_ID );
}
/**
- * get_comment_ID() - Retrieve the comment id of the current comment
+ * 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
+ * @since 1.5.0
*
- * @return int The comment ID
+ * @return int The comment ID.
*/
function get_comment_ID() {
- global $comment;
- return apply_filters('get_comment_ID', $comment->comment_ID);
+ $comment = get_comment();
+
+ /**
+ * Filter the returned comment ID.
+ *
+ * @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` parameter was added.
+ *
+ * @param int $comment_ID The current comment ID.
+ * @param WP_Comment $comment The comment object.
+ */
+ return apply_filters( 'get_comment_ID', $comment->comment_ID, $comment );
}
/**
- * comment_ID() - Displays the comment id of the current comment
+ * Display 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
+ * Retrieve the link to a given comment.
+ *
+ * @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object. Added `$cpage` argument.
*
- * @since 1.5
- * @uses $comment
+ * @see get_page_of_comment()
*
- * @return string The permalink to the current comment
+ * @global WP_Rewrite $wp_rewrite
+ * @global bool $in_comment_loop
+ *
+ * @param WP_Comment|int|null $comment Comment to retrieve. Default current comment.
+ * @param array $args {
+ * An array of optional arguments to override the defaults.
+ *
+ * @type string $type Passed to {@see get_page_of_comment()}.
+ * @type int $page Current page of comments, for calculating comment pagination.
+ * @type int $per_page Per-page value for comment pagination.
+ * @type int $max_depth Passed to {@see get_page_of_comment()}.
+ * @type int|string $cpage Value to use for the comment's "comment-page" or "cpage" value. If provided, this
+ * value overrides any value calculated from `$page` and `$per_page`.
+ * }
+ * @return string The permalink to the given comment.
*/
-function get_comment_link() {
- global $comment;
- return get_permalink( $comment->comment_post_ID ) . '#comment-' . $comment->comment_ID;
+function get_comment_link( $comment = null, $args = array() ) {
+ global $wp_rewrite, $in_comment_loop;
+
+ $comment = get_comment($comment);
+
+ // Backwards compat
+ if ( ! is_array( $args ) ) {
+ $args = array( 'page' => $args );
+ }
+
+ $defaults = array(
+ 'type' => 'all',
+ 'page' => '',
+ 'per_page' => '',
+ 'max_depth' => '',
+ 'cpage' => null,
+ );
+ $args = wp_parse_args( $args, $defaults );
+
+ $link = get_permalink( $comment->comment_post_ID );
+
+ // The 'cpage' param takes precedence.
+ if ( ! is_null( $args['cpage'] ) ) {
+ $cpage = $args['cpage'];
+
+ // No 'cpage' is provided, so we calculate one.
+ } else {
+ 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;
+ }
+
+ $cpage = $args['page'];
+
+ if ( '' == $cpage ) {
+ if ( ! empty( $in_comment_loop ) ) {
+ $cpage = get_query_var( 'cpage' );
+ } else {
+ // Requires a database hit, so we only do it when we can't figure out from context.
+ $cpage = get_page_of_comment( $comment->comment_ID, $args );
+ }
+ }
+
+ /*
+ * If the default page displays the oldest comments, the permalinks for comments on the default page
+ * do not need a 'cpage' query var.
+ */
+ $default_comments_page = get_option( 'default_comments_page' );
+ if ( 'oldest' === get_option( 'default_comments_page' ) && 1 === $cpage ) {
+ $cpage = '';
+ }
+ }
+
+ if ( $cpage ) {
+ if ( $wp_rewrite->using_permalinks() ) {
+ if ( $cpage ) {
+ $link = trailingslashit( $link ) . $wp_rewrite->comments_pagination_base . '-' . $cpage;
+ }
+
+ $link = user_trailingslashit( $link, 'comment' );
+ } elseif ( $cpage ) {
+ $link = add_query_arg( 'cpage', $cpage, $link );
+ }
+
+ }
+
+ if ( $wp_rewrite->using_permalinks() ) {
+ $link = user_trailingslashit( $link, 'comment' );
+ }
+
+ $link = $link . '#comment-' . $comment->comment_ID;
+
+ /**
+ * Filter the returned single comment permalink.
+ *
+ * @since 2.8.0
+ * @since 4.4.0 Added the `$cpage` parameter.
+ *
+ * @see get_page_of_comment()
+ *
+ * @param string $link The comment permalink with '#comment-$id' appended.
+ * @param WP_Comment $comment The current comment object.
+ * @param array $args An array of arguments to override the defaults.
+ * @param int $cpage The calculated 'cpage' value.
+ */
+ return apply_filters( 'get_comment_link', $link, $comment, $args, $cpage );
}
/**
- * get_comments_link() - Retrieves the link to the current post comments
+ * Retrieves the link to the current post comments.
*
- * @since 1.5
+ * @since 1.5.0
*
- * @return string The link to the comments
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
+ * @return string The link to the comments.
*/
-function get_comments_link() {
- return get_permalink() . '#comments';
+function get_comments_link( $post_id = 0 ) {
+ $hash = get_comments_number( $post_id ) ? '#comments' : '#respond';
+ $comments_link = get_permalink( $post_id ) . $hash;
+
+ /**
+ * Filter the returned post comments permalink.
+ *
+ * @since 3.6.0
+ *
+ * @param string $comments_link Post comments permalink with '#comments' appended.
+ * @param int|WP_Post $post_id Post ID or WP_Post object.
+ */
+ return apply_filters( 'get_comments_link', $comments_link, $post_id );
}
/**
- * comments_link() - Displays the link to the current post comments
+ * Display the link to the current post comments.
*
* @since 0.71
*
- * @param string $deprecated Not Used
- * @param bool $deprecated Not Used
+ * @param string $deprecated Not Used.
+ * @param string $deprecated_2 Not Used.
*/
-function comments_link( $deprecated = '', $deprecated = '' ) {
- echo get_comments_link();
+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() );
}
/**
- * get_comments_number() - Retrieve the amount of comments a post has
+ * 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
+ * @since 1.5.0
*
- * @param int $post_id The Post ID
- * @return int The number of comments a post has
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
+ * @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 );
- $post = get_post($post_id);
- if ( ! isset($post->comment_count) )
+ if ( ! $post ) {
$count = 0;
- else
+ } else {
$count = $post->comment_count;
+ $post_id = $post->ID;
+ }
- return apply_filters('get_comments_number', $count);
+ /**
+ * Filter the returned comment count for a post.
+ *
+ * @since 1.5.0
+ *
+ * @param int $count Number of comments a post has.
+ * @param int $post_id Post ID.
+ */
+ return apply_filters( 'get_comments_number', $count, $post_id );
}
/**
- * comments_number() - Display the language string for the number of comments the current post has
+ * 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 $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 = '' ) {
- global $id;
- $number = get_comments_number($id);
-
- if ( $number > 1 )
- $output = str_replace('%', $number, ( false === $more ) ? __('% Comments') : $more);
- elseif ( $number == 0 )
- $output = ( false === $zero ) ? __('No Comments') : $zero;
- else // must be one
- $output = ( false === $one ) ? __('1 Comment') : $one;
+ if ( ! empty( $deprecated ) ) {
+ _deprecated_argument( __FUNCTION__, '1.3' );
+ }
+ echo get_comments_number_text( $zero, $one, $more );
+}
- echo apply_filters('comments_number', $output, $number);
+/**
+ * Display the language string for the number of comments the current post has.
+ *
+ * @since 4.0.0
+ *
+ * @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.
+ */
+function get_comments_number_text( $zero = false, $one = false, $more = false ) {
+ $number = get_comments_number();
+
+ if ( $number > 1 ) {
+ if ( false === $more ) {
+ /* translators: %s: number of comments */
+ $output = sprintf( _n( '%s Comment', '%s Comments', $number ), number_format_i18n( $number ) );
+ } else {
+ // % Comments
+ $output = str_replace( '%', number_format_i18n( $number ), $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
+ *
+ * @see _n()
+ *
+ * @param string $output A translatable string formatted based on whether the count
+ * is equal to 0, 1, or 1+.
+ * @param int $number The number of post comments.
+ */
+ return apply_filters( 'comments_number', $output, $number );
}
/**
- * get_comment_text() - Retrieve the text of the current comment
+ * Retrieve the text of the current comment.
*
- * @since 1.5
- * @uses $comment
+ * @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @return string The comment content
+ * @see Walker_Comment::comment()
+ *
+ * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to get the text.
+ * Default current comment.
+ * @param array $args Optional. An array of arguments. Default empty.
+ * @return string The comment content.
*/
-function get_comment_text() {
- global $comment;
- return apply_filters('get_comment_text', $comment->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
+ *
+ * @see Walker_Comment::comment()
+ *
+ * @param string $comment_content Text of the comment.
+ * @param WP_Comment $comment The comment object.
+ * @param array $args An array of arguments.
+ */
+ return apply_filters( 'get_comment_text', $comment->comment_content, $comment, $args );
}
/**
- * comment_text() - Displays the text of the current comment
+ * Display 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
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
+ *
+ * @see Walker_Comment::comment()
+ *
+ * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the text.
+ * Default current comment.
+ * @param array $args Optional. An array of arguments. Default empty array. Default empty.
*/
-function comment_text() {
- echo apply_filters('comment_text', get_comment_text() );
+function comment_text( $comment_ID = 0, $args = array() ) {
+ $comment = get_comment( $comment_ID );
+
+ $comment_text = get_comment_text( $comment, $args );
+ /**
+ * Filter the text of a comment to be displayed.
+ *
+ * @since 1.2.0
+ *
+ * @see Walker_Comment::comment()
+ *
+ * @param string $comment_text Text of the current comment.
+ * @param WP_Comment $comment The comment object.
+ * @param array $args An array of arguments.
+ */
+ echo apply_filters( 'comment_text', $comment_text, $comment, $args );
}
/**
- * get_comment_time() - Retrieve the comment time of the current comment
+ * 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.
+ * @since 1.5.0
*
- * @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
+ * @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 ) {
- global $comment;
- $comment_date = $gmt? $comment->comment_date_gmt : $comment->comment_date;
+function get_comment_time( $d = '', $gmt = false, $translate = true ) {
+ $comment = get_comment();
+
+ $comment_date = $gmt ? $comment->comment_date_gmt : $comment->comment_date;
if ( '' == $d )
- $date = mysql2date(get_option('time_format'), $comment_date);
+ $date = mysql2date(get_option('time_format'), $comment_date, $translate);
else
- $date = mysql2date($d, $comment_date);
- return apply_filters('get_comment_time', $date, $d, $gmt);
+ $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 Date format.
+ * @param bool $gmt Whether the GMT date is in use.
+ * @param bool $translate Whether the time is translated.
+ * @param WP_Comment $comment The comment object.
+ */
+ return apply_filters( 'get_comment_time', $date, $d, $gmt, $translate, $comment );
}
/**
- * comment_time() - Display the comment time of the current comment
+ * 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)
+ * @param string $d Optional. The format of the time. Default user's settings.
*/
function comment_time( $d = '' ) {
echo get_comment_time($d);
}
/**
- * get_comment_type() - Retrieve the comment type of the current comment
+ * 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
+ * @since 1.5.0
+ * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
*
- * @return string The comment type
+ * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the type.
+ * Default current comment.
+ * @return string The comment type.
*/
-function get_comment_type() {
- global $comment;
-
+function get_comment_type( $comment_ID = 0 ) {
+ $comment = get_comment( $comment_ID );
if ( '' == $comment->comment_type )
$comment->comment_type = 'comment';
- return apply_filters('get_comment_type', $comment->comment_type);
+ /**
+ * Filter the returned comment type.
+ *
+ * @since 1.5.0
+ * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
+ *
+ * @param string $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
+ * @param int $comment_ID The comment ID.
+ * @param WP_Comment $comment The comment object.
+ */
+ return apply_filters( 'get_comment_type', $comment->comment_type, $comment->comment_ID, $comment );
}
/**
- * comment_type() - Display the comment type of the current comment
+ * 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
+ * @param string $commenttxt Optional. String to display for comment type. Default false.
+ * @param string $trackbacktxt Optional. String to display for trackback type. Default false.
+ * @param string $pingbacktxt Optional. String to display for pingback type. Default false.
*/
-function comment_type($commenttxt = 'Comment', $trackbacktxt = 'Trackback', $pingbacktxt = 'Pingback') {
+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' :
@@ -496,125 +1055,169 @@ function comment_type($commenttxt = 'Comment', $trackbacktxt = 'Trackback', $pin
}
/**
- * get_trackback_url() - Retrieve The current post's 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.
+ * 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
+ * @since 1.5.0
*
- * @return string The trackback URL after being filtered
+ * @return string The trackback URL after being filtered.
*/
function get_trackback_url() {
- global $id;
- if ( '' != get_option('permalink_structure') ) {
+ 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);
+ 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 );
}
/**
- * trackback_url() - Displays the current post's trackback URL
+ * Display 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.
+ * @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 = true) {
- if ($deprecated) echo get_trackback_url();
- else return get_trackback_url();
+function trackback_url( $deprecated_echo = true ) {
+ if ( true !== $deprecated_echo ) {
+ _deprecated_argument( __FUNCTION__, '2.5',
+ /* translators: %s: get_trackback_url() */
+ sprintf( __( 'Use %s instead if you do not want the value echoed.' ),
+ 'get_trackback_url()
'
+ )
+ );
+ }
+
+ if ( $deprecated_echo ) {
+ echo get_trackback_url();
+ } else {
+ return get_trackback_url();
+ }
}
/**
- * trackback_rdf() - Generates and displays the RDF for the trackback information of current post
+ * 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)
+ * @param int $deprecated Not used (Was $timezone = 0).
*/
-function trackback_rdf($deprecated = '') {
- if (stripos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') === false) {
- echo '
%1$s %2$s', where %1$s is the + * submit button markup and %2$s is the comment hidden fields. + * @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'. + * } + * @param int|WP_Post $post_id Post ID or WP_Post object to generate the form for. Default current post. + */ +function comment_form( $args = array(), $post_id = null ) { + if ( null === $post_id ) + $post_id = get_the_ID(); + + $commenter = wp_get_current_commenter(); + $user = wp_get_current_user(); + $user_identity = $user->exists() ? $user->display_name : ''; + + $args = wp_parse_args( $args ); + if ( ! isset( $args['format'] ) ) + $args['format'] = current_theme_supports( 'html5', 'comment-form' ) ? 'html5' : 'xhtml'; + + $req = get_option( 'require_name_email' ); + $aria_req = ( $req ? " aria-required='true'" : '' ); + $html_req = ( $req ? " required='required'" : '' ); + $html5 = 'html5' === $args['format']; + $fields = array( + 'author' => '
', + 'email' => '' . + '
', + 'url' => '' . + '
', + ); + + $required_text = sprintf( ' ' . __('Required fields are marked %s'), '*' ); + + /** + * Filter the default comment form fields. + * + * @since 3.0.0 + * + * @param array $fields The default comment fields. + */ + $fields = apply_filters( 'comment_form_default_fields', $fields ); + $defaults = array( + 'fields' => $fields, + 'comment_field' => '', + /** This filter is documented in wp-includes/link-template.php */ + 'must_log_in' => '
' . sprintf( __( 'You must be logged in to post a comment.' ), wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '
', + /** This filter is documented in wp-includes/link-template.php */ + 'logged_in_as' => '' . sprintf( __( 'Logged in as %2$s. Log out?' ), get_edit_user_link(), $user_identity, wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) ) . '
', + 'comment_notes_before' => '' . __( 'Your email address will not be published.' ) . ''. ( $req ? $required_text : '' ) . '
', + 'comment_notes_after' => '', + 'id_form' => 'commentform', + 'id_submit' => 'submit', + 'class_form' => 'comment-form', + 'class_submit' => 'submit', + 'name_submit' => 'submit', + 'title_reply' => __( 'Leave a Reply' ), + 'title_reply_to' => __( 'Leave a Reply to %s' ), + 'title_reply_before' => '%1$s %2$s
', + 'format' => 'xhtml', + ); + + /** + * Filter the comment form default arguments. + * + * Use 'comment_form_default_fields' to filter the comment fields. + * + * @since 3.0.0 + * + * @param array $defaults The default comment form arguments. + */ + $args = wp_parse_args( $args, apply_filters( 'comment_form_defaults', $defaults ) ); + + // Ensure that the filtered args contain all required default values. + $args = array_merge( $defaults, $args ); + + if ( comments_open( $post_id ) ) : ?> + +