mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-31 13:37:51 +01:00
Inline documentation cleanup in wp-includes/comment-template.php.
This cleanup follows [25567] and brings the docs in-line with standards that at the time had not yet been finalized. These changes include * Moving in-line `@see` tags to their own lines * Using docs-specific variables in hook docs * Fixing line-wrapping throughout * Typos and punctuation * Converting hash notation values to variables per the standard Fixes #27083. See #20495. Built from https://develop.svn.wordpress.org/trunk@27156 git-svn-id: http://core.svn.wordpress.org/trunk@27022 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
parent
eba12cfaf4
commit
8eb2d3610b
@ -76,7 +76,7 @@ function get_comment_author_email( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string $comment->comment_author_email The comment author's email address.
|
||||
* @param string $comment_author_email The comment author's email address.
|
||||
*/
|
||||
return apply_filters( 'get_comment_author_email', $comment->comment_author_email );
|
||||
}
|
||||
@ -119,9 +119,10 @@ function comment_author_email( $comment_ID = 0 ) {
|
||||
|
||||
* @since 0.71
|
||||
*
|
||||
* @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.
|
||||
* @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 = '' ) {
|
||||
if ( $link = get_comment_author_email_link( $linktext, $before, $after ) )
|
||||
@ -141,9 +142,10 @@ function comment_author_email_link( $linktext = '', $before = '', $after = '' )
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @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.
|
||||
* @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 get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
|
||||
global $comment;
|
||||
@ -151,11 +153,11 @@ function get_comment_author_email_link( $linktext = '', $before = '', $after = '
|
||||
* 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 commentors' email address.
|
||||
* harvesters do not capture your commenters' email address.
|
||||
*
|
||||
* @since 1.2.0
|
||||
*
|
||||
* @param string $comment->comment_author_email The comment author's email address.
|
||||
* @param string $comment_author_email The comment author's email address.
|
||||
*/
|
||||
$email = apply_filters( 'comment_email', $comment->comment_author_email );
|
||||
if ((!empty($email)) && ($email != '@')) {
|
||||
@ -177,7 +179,8 @@ function get_comment_author_email_link( $linktext = '', $before = '', $after = '
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to get the author's link. Default current comment.
|
||||
* @param int $comment_ID 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( $comment_ID = 0 ) {
|
||||
@ -194,7 +197,8 @@ function get_comment_author_link( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string $return The HTML-formatted comment author link. Empty for an invalid URL.
|
||||
* @param string $return The HTML-formatted comment author link.
|
||||
* Empty for an invalid URL.
|
||||
*/
|
||||
return apply_filters( 'get_comment_author_link', $return );
|
||||
}
|
||||
@ -203,9 +207,11 @@ function get_comment_author_link( $comment_ID = 0 ) {
|
||||
* Display the html link to the url of the author of the current comment.
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @see get_comment_author_link() Echoes result
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to print the author's link. Default current comment.
|
||||
* @param int $comment_ID ID of the comment for which to print the author's
|
||||
* link. Default current comment.
|
||||
*/
|
||||
function comment_author_link( $comment_ID = 0 ) {
|
||||
echo get_comment_author_link( $comment_ID );
|
||||
@ -216,8 +222,9 @@ function comment_author_link( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to get the author's IP address. Default current comment.
|
||||
* @return string The comment author's IP address.
|
||||
* @param int $comment_ID 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( $comment_ID = 0 ) {
|
||||
$comment = get_comment( $comment_ID );
|
||||
@ -227,7 +234,7 @@ function get_comment_author_IP( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string $comment->comment_author_IP The comment author's IP address.
|
||||
* @param string $comment_author_IP The comment author's IP address.
|
||||
*/
|
||||
return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP );
|
||||
}
|
||||
@ -237,7 +244,8 @@ function get_comment_author_IP( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to print the author's IP address. Default current comment.
|
||||
* @param int $comment_ID ID of the comment for which to print the author's IP
|
||||
* address. Default current comment.
|
||||
*/
|
||||
function comment_author_IP( $comment_ID = 0 ) {
|
||||
echo get_comment_author_IP( $comment_ID );
|
||||
@ -248,7 +256,8 @@ function comment_author_IP( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to get the author's URL. Default current comment.
|
||||
* @param int $comment_ID ID of the comment for which to get the author's URL.
|
||||
* Default current comment.
|
||||
* @return string
|
||||
*/
|
||||
function get_comment_author_url( $comment_ID = 0 ) {
|
||||
@ -270,7 +279,8 @@ function get_comment_author_url( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to print the author's URL. Default current comment.
|
||||
* @param int $comment_ID ID of the comment for which to print the author's URL.
|
||||
* Default current comment.
|
||||
*/
|
||||
function comment_author_url( $comment_ID = 0 ) {
|
||||
$author_url = get_comment_author_url( $comment_ID );
|
||||
@ -296,9 +306,12 @@ function comment_author_url( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @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.
|
||||
* @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 = '' ) {
|
||||
@ -325,23 +338,28 @@ function get_comment_author_url_link( $linktext = '', $before = '', $after = ''
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @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.
|
||||
* @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 );
|
||||
}
|
||||
|
||||
/**
|
||||
* Generates semantic classes for each comment element
|
||||
* Generates semantic classes for each comment element.
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param string|array $class Optional. One or more classes to add to the class list. Default empty.
|
||||
* @param int $comment_id Optional. Comment ID. Default current comment.
|
||||
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
|
||||
* @param bool $echo Optional. Whether comment_class should echo or return. Default true.
|
||||
* @param string|array $class Optional. One or more classes to add to the class list.
|
||||
* Default empty.
|
||||
* @param int $comment_id Comment ID. 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.
|
||||
*/
|
||||
function comment_class( $class = '', $comment_id = null, $post_id = null, $echo = true ) {
|
||||
// Separates classes with a single space, collates classes for comment DIV
|
||||
@ -353,13 +371,13 @@ function comment_class( $class = '', $comment_id = null, $post_id = null, $echo
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the classes for the comment div as an array
|
||||
* Returns the classes for the comment div as an array.
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param string|array $class Optional. One or more classes to add to the class list. Default empty.
|
||||
* @param int $comment_id Optional. Comment ID. Default current comment.
|
||||
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
|
||||
* @param int $comment_id Comment ID. 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 ) {
|
||||
@ -440,7 +458,7 @@ function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string $d Optional. The format of the date. Default user's setting.
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to get the date. Default current comment.
|
||||
* @param int $comment_ID ID of the comment for which to get the date. Default current comment.
|
||||
* @return string The comment's date.
|
||||
*/
|
||||
function get_comment_date( $d = '', $comment_ID = 0 ) {
|
||||
@ -466,7 +484,7 @@ function get_comment_date( $d = '', $comment_ID = 0 ) {
|
||||
* @since 0.71
|
||||
*
|
||||
* @param string $d Optional. The format of the date. Default user's settings.
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to print the date. Default current comment.
|
||||
* @param int $comment_ID ID of the comment for which to print the date. Default current comment.
|
||||
*/
|
||||
function comment_date( $d = '', $comment_ID = 0 ) {
|
||||
echo get_comment_date( $d, $comment_ID );
|
||||
@ -481,7 +499,8 @@ function comment_date( $d = '', $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to get the excerpt. Default current comment.
|
||||
* @param int $comment_ID 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( $comment_ID = 0 ) {
|
||||
@ -508,7 +527,8 @@ function get_comment_excerpt( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 1.2.0
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to print the excerpt. Default current comment.
|
||||
* @param int $comment_ID ID of the comment for which to print the excerpt.
|
||||
* Default current comment.
|
||||
*/
|
||||
function comment_excerpt( $comment_ID = 0 ) {
|
||||
$comment_excerpt = get_comment_excerpt($comment_ID);
|
||||
@ -536,7 +556,7 @@ function get_comment_ID() {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $comment->comment_ID The current comment ID.
|
||||
* @param int $comment_ID The current comment ID.
|
||||
*/
|
||||
return apply_filters( 'get_comment_ID', $comment->comment_ID );
|
||||
}
|
||||
@ -555,8 +575,10 @@ function comment_ID() {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param mixed $comment Optional. Comment to retrieve. Default current comment.
|
||||
* @param array $args Optional. An array of arguments to override the defaults. @see get_page_of_comment()
|
||||
* @see get_page_of_comment()
|
||||
*
|
||||
* @param mixed $comment Comment to retrieve. Default current comment.
|
||||
* @param array $args Optional. An array of arguments to override the defaults.
|
||||
* @return string The permalink to the given comment.
|
||||
*/
|
||||
function get_comment_link( $comment = null, $args = array() ) {
|
||||
@ -600,9 +622,11 @@ function get_comment_link( $comment = null, $args = array() ) {
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @see get_page_of_comment()
|
||||
*
|
||||
* @param string $link The comment permalink with '#comment-$id' appended.
|
||||
* @param object $comment The current comment object.
|
||||
* @param array $args An array of arguments to override the defaults. @see get_page_of_comment()
|
||||
* @param array $args An array of arguments to override the defaults.
|
||||
*/
|
||||
return apply_filters( 'get_comment_link', $link, $comment, $args );
|
||||
}
|
||||
@ -612,7 +636,7 @@ function get_comment_link( $comment = null, $args = array() ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
|
||||
* @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
|
||||
* @return string The link to the comments.
|
||||
*/
|
||||
function get_comments_link( $post_id = 0 ) {
|
||||
@ -622,8 +646,8 @@ function get_comments_link( $post_id = 0 ) {
|
||||
*
|
||||
* @since
|
||||
*
|
||||
* @param string $comments_link The post comments permalink with '#comments' appended.
|
||||
* @param int|WP_Post $post_id The post ID or WP_Post object.
|
||||
* @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 );
|
||||
}
|
||||
@ -649,7 +673,7 @@ function comments_link( $deprecated = '', $deprecated_2 = '' ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
|
||||
* @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
|
||||
* @return int The number of comments a post has.
|
||||
*/
|
||||
function get_comments_number( $post_id = 0 ) {
|
||||
@ -669,8 +693,8 @@ function get_comments_number( $post_id = 0 ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $count The number of comments a post has.
|
||||
* @param int|WP_Post $post_id The post ID or WP_Post object.
|
||||
* @param int $count Nnumber of comments a post has.
|
||||
* @param int|WP_Post $post_id Post ID or WP_Post object.
|
||||
*/
|
||||
return apply_filters( 'get_comments_number', $count, $post_id );
|
||||
}
|
||||
@ -703,7 +727,10 @@ function comments_number( $zero = false, $one = false, $more = false, $deprecate
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string $output A translatable string formatted based on whether the count is equal to 0, 1, or 1+. @see _n()
|
||||
* @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.
|
||||
*/
|
||||
echo apply_filters( 'comments_number', $output, $number );
|
||||
@ -714,8 +741,10 @@ function comments_number( $zero = false, $one = false, $more = false, $deprecate
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to get the text. Default current comment.
|
||||
* @param array $args Optional. An array of arguments. @see Walker_Comment::comment()
|
||||
* @see Walker_Comment::comment()
|
||||
*
|
||||
* @param int $comment_ID 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( $comment_ID = 0, $args = array() ) {
|
||||
@ -726,9 +755,11 @@ function get_comment_text( $comment_ID = 0, $args = array() ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string $comment->comment_content The text of the comment.
|
||||
* @param object $comment The comment object.
|
||||
* @param array $args An array of arguments. @see Walker_Comment::comment()
|
||||
* @see Walker_Comment::comment()
|
||||
*
|
||||
* @param string $comment_content Text of the comment.
|
||||
* @param object $comment The comment object.
|
||||
* @param array $args An array of arguments.
|
||||
*/
|
||||
return apply_filters( 'get_comment_text', $comment->comment_content, $comment, $args );
|
||||
}
|
||||
@ -738,10 +769,10 @@ function get_comment_text( $comment_ID = 0, $args = array() ) {
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to print the text.
|
||||
* Default 0.
|
||||
* @param array $args Optional. An array of arguments. @see Walker_Comment::comment()
|
||||
* Default empty array.
|
||||
* @see Walker_Comment::comment()
|
||||
*
|
||||
* @param int $comment_ID ID of the comment for which to print the text. Default 0.
|
||||
* @param array $args Optional. An array of arguments. Default empty array. Default empty.
|
||||
*/
|
||||
function comment_text( $comment_ID = 0, $args = array() ) {
|
||||
$comment = get_comment( $comment_ID );
|
||||
@ -752,9 +783,11 @@ function comment_text( $comment_ID = 0, $args = array() ) {
|
||||
*
|
||||
* @since 1.2.0
|
||||
*
|
||||
* @param string $comment_text The text of the current comment.
|
||||
* @see Walker_Comment::comment()
|
||||
*
|
||||
* @param string $comment_text Text of the current comment.
|
||||
* @param object $comment The comment object.
|
||||
* @param array $args An array of arguments. @see Walker_Comment::comment()
|
||||
* @param array $args An array of arguments.
|
||||
*/
|
||||
echo apply_filters( 'comment_text', $comment_text, $comment, $args );
|
||||
}
|
||||
@ -766,8 +799,9 @@ function comment_text( $comment_ID = 0, $args = array() ) {
|
||||
*
|
||||
* @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
|
||||
* @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, $translate = true ) {
|
||||
global $comment;
|
||||
@ -783,7 +817,7 @@ function get_comment_time( $d = '', $gmt = false, $translate = true ) {
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string|int $date The comment time, formatted as a date string or Unix timestamp.
|
||||
* @param string $d The date format.
|
||||
* @param string $d Date format.
|
||||
* @param bool $gmt Whether the GMT date is in use.
|
||||
* @param bool $translate Whether the time is translated.
|
||||
*/
|
||||
@ -806,8 +840,8 @@ function comment_time( $d = '' ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $comment_ID Optional. The ID of the comment for which to get the type. Default current comment.
|
||||
* @return string The comment type
|
||||
* @param int $comment_ID ID of the comment for which to get the type. Default current comment.
|
||||
* @return string The comment type.
|
||||
*/
|
||||
function get_comment_type( $comment_ID = 0 ) {
|
||||
$comment = get_comment( $comment_ID );
|
||||
@ -819,7 +853,7 @@ function get_comment_type( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string $comment->comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
|
||||
* @param string $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
|
||||
*/
|
||||
return apply_filters( 'get_comment_type', $comment->comment_type );
|
||||
}
|
||||
@ -829,9 +863,9 @@ function get_comment_type( $comment_ID = 0 ) {
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @param string $commenttxt Optional. The string to display for comment type. Default false.
|
||||
* @param string $trackbacktxt Optional. The string to display for trackback type. Default false.
|
||||
* @param string $pingbacktxt Optional. The string to display for pingback type. Default false.
|
||||
* @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 = false, $trackbacktxt = false, $pingbacktxt = false ) {
|
||||
if ( false === $commenttxt ) $commenttxt = _x( 'Comment', 'noun' );
|
||||
@ -883,7 +917,8 @@ function get_trackback_url() {
|
||||
* @since 0.71
|
||||
*
|
||||
* @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.
|
||||
* @return void|string Should only be used to echo the trackback URL, use get_trackback_url()
|
||||
* for the result instead.
|
||||
*/
|
||||
function trackback_url( $deprecated_echo = true ) {
|
||||
if ( $deprecated_echo !== true )
|
||||
@ -929,7 +964,7 @@ function trackback_rdf( $deprecated = '' ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
|
||||
* @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
|
||||
* @return bool True if the comments are open.
|
||||
*/
|
||||
function comments_open( $post_id = null ) {
|
||||
@ -954,7 +989,7 @@ function comments_open( $post_id = null ) {
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default current post.
|
||||
* @param int|WP_Post $post_id Post ID or WP_Post object. Default current post.
|
||||
* @return bool True if pings are accepted
|
||||
*/
|
||||
function pings_open( $post_id = null ) {
|
||||
@ -1011,7 +1046,8 @@ function wp_comment_form_unfiltered_html_nonce() {
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string $file Optional. The file to load. Default '/comments.php'.
|
||||
* @param bool $separate_comments Optional. Whether to separate the comments by comment type. Default false.
|
||||
* @param bool $separate_comments Optional. Whether to separate the comments by comment type.
|
||||
* Default false.
|
||||
* @return null Returns null if no comments appear.
|
||||
*/
|
||||
function comments_template( $file = '/comments.php', $separate_comments = false ) {
|
||||
@ -1025,24 +1061,25 @@ function comments_template( $file = '/comments.php', $separate_comments = false
|
||||
|
||||
$req = get_option('require_name_email');
|
||||
|
||||
/**
|
||||
/*
|
||||
* Comment author information fetched from the comment cookies.
|
||||
*
|
||||
* @uses wp_get_current_commenter()
|
||||
* Uuses wp_get_current_commenter().
|
||||
*/
|
||||
$commenter = wp_get_current_commenter();
|
||||
|
||||
/**
|
||||
/*
|
||||
* The name of the current comment author escaped for use in attributes.
|
||||
* Escaped by sanitize_comment_cookies().
|
||||
*/
|
||||
$comment_author = $commenter['comment_author']; // Escaped by sanitize_comment_cookies()
|
||||
$comment_author = $commenter['comment_author'];
|
||||
|
||||
/**
|
||||
/*
|
||||
* The email address of the current comment author escaped for use in attributes.
|
||||
* Escaped by sanitize_comment_cookies().
|
||||
*/
|
||||
$comment_author_email = $commenter['comment_author_email']; // Escaped by sanitize_comment_cookies()
|
||||
$comment_author_email = $commenter['comment_author_email'];
|
||||
|
||||
/**
|
||||
/*
|
||||
* The url of the current comment author escaped for use in attributes.
|
||||
*/
|
||||
$comment_author_url = esc_url($commenter['comment_author_url']);
|
||||
@ -1056,14 +1093,13 @@ function comments_template( $file = '/comments.php', $separate_comments = false
|
||||
$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_gmt", $post->ID, wp_specialchars_decode($comment_author,ENT_QUOTES), $comment_author_email));
|
||||
}
|
||||
|
||||
// keep $comments for legacy's sake
|
||||
/**
|
||||
* Filter the comments array.
|
||||
*
|
||||
* @since 2.1.0
|
||||
*
|
||||
* @param array $comments The array of comments supplied to the comments template.
|
||||
* @param int $post->ID The post ID.
|
||||
* @param array $comments Array of comments supplied to the comments template.
|
||||
* @param int $post_ID Post ID.
|
||||
*/
|
||||
$wp_query->comments = apply_filters( 'comments_array', $comments, $post->ID );
|
||||
$comments = &$wp_query->comments;
|
||||
@ -1136,19 +1172,22 @@ function comments_popup_script( $width = 400, $height = 400, $file = '' ) {
|
||||
/**
|
||||
* 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
|
||||
* Is not meant to be displayed on single posts and pages. Should be used
|
||||
* on the lists of posts
|
||||
*
|
||||
* @global string $wpcommentspopupfile The URL to use for the popup window.
|
||||
* @global int $wpcommentsjavascript Whether to use JavaScript. Set when function is called.
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @param string $zero Optional. The string to display when no comments. Default false.
|
||||
* @param string $one Optional. The string to display when only one comment is available. Default false.
|
||||
* @param string $more Optional. The string to display when there are more than one comment. Default false.
|
||||
* @param string $css_class Optional. The CSS class to use for comments. Default empty.
|
||||
* @param string $none Optional. The string to display when comments have been turned off. Default false.
|
||||
* @param string $zero Optional. String to display when no comments. Default false.
|
||||
* @param string $one Optional. String to display when only one comment is available.
|
||||
* Default false.
|
||||
* @param string $more Optional. String to display when there are more than one comment.
|
||||
* Default false.
|
||||
* @param string $css_class Optional. CSS class to use for comments. Default empty.
|
||||
* @param string $none Optional. String to display when comments have been turned off.
|
||||
* Default false.
|
||||
* @return null Returns null on single posts and pages.
|
||||
*/
|
||||
function comments_popup_link( $zero = false, $one = false, $more = false, $css_class = '', $none = false ) {
|
||||
@ -1217,21 +1256,22 @@ function comments_popup_link( $zero = false, $one = false, $more = false, $css_c
|
||||
* @param array $args {
|
||||
* Optional. Override default arguments.
|
||||
*
|
||||
* @type string 'add_below' The first part of the selector used to identify the comment to respond below. The resulting
|
||||
* value is passed as the first parameter to addComment.moveForm(), concatenated
|
||||
* as $add_below-$comment->comment_ID. Default 'comment'.
|
||||
* @type string 'respond_id' The selector identifying the responding comment. Passed as the third parameter to addComment.moveForm(),
|
||||
* and appended to the link URL as a hash value. Default 'respond'.
|
||||
* @type string 'reply_text' The text of the Reply link. Default 'Reply'.
|
||||
* @type string 'login_text' The text of the link to reply if logged out. Default 'Log in to Reply'.
|
||||
* @type int 'depth' The depth of the new comment. Must be greater than 0 and less than the value of the 'thread_comments_depth'
|
||||
* option set in Settings > Discussion.
|
||||
* Default 0.
|
||||
* @type string 'before' The text or HTML to add before the reply link. Default empty.
|
||||
* @type string 'after' The text or HTML to add after the reply link. Default empty.
|
||||
* @type string $add_below The first part of the selector used to identify the comment to respond below.
|
||||
* The resulting value is passed as the first parameter to addComment.moveForm(),
|
||||
* concatenated as $add_below-$comment->comment_ID. Default 'comment'.
|
||||
* @type string $respond_id The selector identifying the responding comment. Passed as the third parameter
|
||||
* to addComment.moveForm(), and appended to the link URL as a hash value.
|
||||
* Default 'respond'.
|
||||
* @type string $reply_text The text of the Reply link. Default 'Reply'.
|
||||
* @type string $login_text The text of the link to reply if logged out. Default 'Log in to Reply'.
|
||||
* @type int $depth' The depth of the new comment. Must be greater than 0 and less than the value
|
||||
* of the 'thread_comments_depth' option set in Settings > Discussion. Default 0.
|
||||
* @type string $before The text or HTML to add before the reply link. Default empty.
|
||||
* @type string $after The text or HTML to add after the reply link. Default empty.
|
||||
* }
|
||||
* @param int $comment Optional. Comment being replied to. Default current comment.
|
||||
* @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
|
||||
* @param int $comment Comment being replied to. Default current comment.
|
||||
* @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
|
||||
* Default current post.
|
||||
* @return mixed Link to show comment form, if successful. False, if comments are closed.
|
||||
*/
|
||||
function get_comment_reply_link($args = array(), $comment = null, $post = null) {
|
||||
@ -1273,9 +1313,7 @@ function get_comment_reply_link($args = array(), $comment = null, $post = null)
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param string $before Text or HTML displayed before the reply link.
|
||||
* @param string $link The HTML markup for the comment reply link.
|
||||
* @param string $after Text or HTML displayed after the reply link.
|
||||
* @param array $args An array of arguments overriding the defaults.
|
||||
* @param object $comment The object of the comment being replied.
|
||||
* @param WP_Post $post The WP_Post object.
|
||||
@ -1288,9 +1326,12 @@ function get_comment_reply_link($args = array(), $comment = null, $post = null)
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param array $args Optional. Override default options, @see get_comment_reply_link()
|
||||
* @param int $comment Optional. Comment being replied to. Default current comment.
|
||||
* @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
|
||||
* @see get_comment_reply_link()
|
||||
*
|
||||
* @param array $args Optional. Override default options.
|
||||
* @param int $comment Comment being replied to. Default current comment.
|
||||
* @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
|
||||
* Default current post.
|
||||
* @return mixed Link to show comment form, if successful. False, if comments are closed.
|
||||
*/
|
||||
function comment_reply_link($args = array(), $comment = null, $post = null) {
|
||||
@ -1305,17 +1346,19 @@ function comment_reply_link($args = array(), $comment = null, $post = null) {
|
||||
* @param array $args {
|
||||
* Optional. Override default arguments.
|
||||
*
|
||||
* @type string 'add_below' The first part of the selector used to identify the comment to respond below.
|
||||
* The resulting value is passed as the first parameter to addComment.moveForm(),
|
||||
* concatenated as $add_below-$comment->comment_ID. Default is 'post'.
|
||||
* @type string 'respond_id' The selector identifying the responding comment. Passed as the third parameter
|
||||
* to addComment.moveForm(), and appended to the link URL as a hash value. Default is 'respond'.
|
||||
* @type string 'reply_text' The text of the Reply link. Default is 'Leave a Comment'.
|
||||
* @type string 'login_text' The text of the link to reply if logged out. Default is 'Log in to leave a Comment'.
|
||||
* @type string 'before' The text or HTML to add before the reply link. Default empty.
|
||||
* @type string 'after' The text or HTML to add after the reply link. Default empty.
|
||||
* @type string $add_below The first part of the selector used to identify the comment to respond below.
|
||||
* The resulting value is passed as the first parameter to addComment.moveForm(),
|
||||
* concatenated as $add_below-$comment->comment_ID. Default is 'post'.
|
||||
* @type string $respond_id The selector identifying the responding comment. Passed as the third parameter
|
||||
* to addComment.moveForm(), and appended to the link URL as a hash value.
|
||||
* Default 'respond'.
|
||||
* @type string $reply_text Text of the Reply link. Default is 'Leave a Comment'.
|
||||
* @type string $login_text Text of the link to reply if logged out. Default is 'Log in to leave a Comment'.
|
||||
* @type string $before Text or HTML to add before the reply link. Default empty.
|
||||
* @type string $after Text or HTML to add after the reply link. Default empty.
|
||||
* }
|
||||
* @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
|
||||
* @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on.
|
||||
* Default current post.
|
||||
* @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
|
||||
*/
|
||||
function get_post_reply_link($args = array(), $post = null) {
|
||||
@ -1357,8 +1400,11 @@ function get_post_reply_link($args = array(), $post = null) {
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param array $args Optional. Override default options, @see get_post_reply_link()
|
||||
* @param int|WP_Post $post Optional. Post ID or WP_Post object the comment is going to be displayed on. Default current post.
|
||||
* @see get_post_reply_link()
|
||||
*
|
||||
* @param array $args Optional. Override default options,
|
||||
* @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
|
||||
* Default current post.
|
||||
* @return string|bool|null Link to show comment form, if successful. False, if comments are closed.
|
||||
*/
|
||||
function post_reply_link($args = array(), $post = null) {
|
||||
@ -1386,8 +1432,8 @@ function get_cancel_comment_reply_link( $text = '' ) {
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param string $formatted_link The HTML-formatted cancel comment reply link.
|
||||
* @param string $link The cancel comment reply link URL.
|
||||
* @param string $text The cancel comment reply link text.
|
||||
* @param string $link Cancel comment reply link URL.
|
||||
* @param string $text Cancel comment reply link text.
|
||||
*/
|
||||
return apply_filters( 'cancel_comment_reply_link', $formatted_link, $link, $text );
|
||||
}
|
||||
@ -1449,10 +1495,13 @@ function comment_id_fields( $id = 0 ) {
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param string $noreplytext Optional. Text to display when not replying to a comment. Default false.
|
||||
* @param string $noreplytext Optional. Text to display when not replying to a comment.
|
||||
* Default false.
|
||||
* @param string $replytext Optional. Text to display when replying to a comment.
|
||||
* Default false. Accepts "%s" for the author of the comment being replied to.
|
||||
* @param string $linktoparent Optional. Boolean to control making the author's name a link to their comment. Default true.
|
||||
* Default false. Accepts "%s" for the author of the comment
|
||||
* being replied to.
|
||||
* @param string $linktoparent Optional. Boolean to control making the author's name a link
|
||||
* to their comment. Default true.
|
||||
*/
|
||||
function comment_form_title( $noreplytext = false, $replytext = false, $linktoparent = true ) {
|
||||
global $comment;
|
||||
@ -1573,6 +1622,7 @@ class Walker_Comment extends Walker {
|
||||
* 2.2
|
||||
*
|
||||
* @see Walker::display_element()
|
||||
* @see wp_list_comments()
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
@ -1580,7 +1630,7 @@ class Walker_Comment extends Walker {
|
||||
* @param array $children_elements List of elements to continue traversing.
|
||||
* @param int $max_depth Max depth to traverse.
|
||||
* @param int $depth Depth of current element.
|
||||
* @param array $args An array of arguments. @see wp_list_comments()
|
||||
* @param array $args An array of arguments.
|
||||
* @param string $output Passed by reference. Used to append additional content.
|
||||
* @return null Null on failure with no changes to parameters.
|
||||
*/
|
||||
@ -1608,14 +1658,15 @@ class Walker_Comment extends Walker {
|
||||
/**
|
||||
* Start the element output.
|
||||
*
|
||||
* @see Walker::start_el()
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @see Walker::start_el()
|
||||
* @see wp_list_comments()
|
||||
*
|
||||
* @param string $output Passed by reference. Used to append additional content.
|
||||
* @param object $comment Comment data object.
|
||||
* @param int $depth Depth of comment in reference to parents.
|
||||
* @param array $args An array of arguments. @see wp_list_comments()
|
||||
* @param array $args An array of arguments.
|
||||
*/
|
||||
function start_el( &$output, $comment, $depth = 0, $args = array(), $id = 0 ) {
|
||||
$depth++;
|
||||
@ -1647,14 +1698,15 @@ class Walker_Comment extends Walker {
|
||||
/**
|
||||
* Ends the element output, if needed.
|
||||
*
|
||||
* @see Walker::end_el()
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @see Walker::end_el()
|
||||
* @see wp_list_comments()
|
||||
*
|
||||
* @param string $output Passed by reference. Used to append additional content.
|
||||
* @param object $comment The comment object. Default current comment.
|
||||
* @param int $depth Depth of comment.
|
||||
* @param array $args An array of arguments. @see wp_list_comments()
|
||||
* @param array $args An array of arguments.
|
||||
*/
|
||||
function end_el( &$output, $comment, $depth = 0, $args = array() ) {
|
||||
if ( !empty( $args['end-callback'] ) ) {
|
||||
@ -1675,9 +1727,11 @@ class Walker_Comment extends Walker {
|
||||
* @access protected
|
||||
* @since 3.6.0
|
||||
*
|
||||
* @see wp_list_comments()
|
||||
*
|
||||
* @param object $comment The comment object.
|
||||
* @param int $depth Depth of comment.
|
||||
* @param array $args An array of arguments. @see wp_list_comments()
|
||||
* @param array $args An array of arguments.
|
||||
*/
|
||||
protected function ping( $comment, $depth, $args ) {
|
||||
$tag = ( 'div' == $args['style'] ) ? 'div' : 'li';
|
||||
@ -1695,9 +1749,11 @@ class Walker_Comment extends Walker {
|
||||
* @access protected
|
||||
* @since 3.6.0
|
||||
*
|
||||
* @see wp_list_comments()
|
||||
*
|
||||
* @param object $comment Comment to display.
|
||||
* @param int $depth Depth of comment.
|
||||
* @param array $args An array of arguments. @see wp_list_comments()
|
||||
* @param array $args An array of arguments.
|
||||
*/
|
||||
protected function comment( $comment, $depth, $args ) {
|
||||
if ( 'div' == $args['style'] ) {
|
||||
@ -1745,9 +1801,11 @@ class Walker_Comment extends Walker {
|
||||
* @access protected
|
||||
* @since 3.6.0
|
||||
*
|
||||
* @see wp_list_comments()
|
||||
*
|
||||
* @param object $comment Comment to display.
|
||||
* @param int $depth Depth of comment.
|
||||
* @param array $args An array of arguments. @see wp_list_comments()
|
||||
* @param array $args An array of arguments.
|
||||
*/
|
||||
protected function html5_comment( $comment, $depth, $args ) {
|
||||
$tag = ( 'div' === $args['style'] ) ? 'div' : 'li';
|
||||
@ -1793,27 +1851,29 @@ class Walker_Comment extends Walker {
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @see WP_Query->comments
|
||||
*
|
||||
* @param string|array $args {
|
||||
* Optional. Formatting options.
|
||||
*
|
||||
* @type string 'walker' The Walker class used to list comments. Default null.
|
||||
* @type int 'max_depth' The maximum comments depth. Default empty.
|
||||
* @type string 'style' The style of list ordering. Default 'ul'. Accepts 'ul', 'ol'.
|
||||
* @type string 'callback' Callback function to use. Default null.
|
||||
* @type string 'end-callback' Callback function to use at the end. Default null.
|
||||
* @type string 'type' Type of comments to list.
|
||||
* Default 'all'. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'.
|
||||
* @type int 'page' Page ID to list comments for. Default empty.
|
||||
* @type int 'per_page' Number of comments to list per page. Default empty.
|
||||
* @type int 'avatar_size' Height and width dimensions of the avatar size. Default 32.
|
||||
* @type string 'reverse_top_level' Ordering of the listed comments. Default null. Accepts 'desc', 'asc'.
|
||||
* @type bool 'reverse_children' Whether to reverse child comments in the list. Default null.
|
||||
* @type string 'format' How to format the comments list.
|
||||
* Default 'html5' if the theme supports it. Accepts 'html5', 'xhtml'.
|
||||
* @type bool 'short_ping' Whether to output short pings. Default false.
|
||||
* @type bool 'echo' Whether to echo the output or return it. Default true.
|
||||
* @type string $walker The Walker class used to list comments. Default null.
|
||||
* @type int $max_depth The maximum comments depth. Default empty.
|
||||
* @type string $style The style of list ordering. Default 'ul'. Accepts 'ul', 'ol'.
|
||||
* @type string $callback Callback function to use. Default null.
|
||||
* @type string $end-callback Callback function to use at the end. Default null.
|
||||
* @type string $type Type of comments to list.
|
||||
* Default 'all'. Accepts 'all', 'comment', 'pingback', 'trackback', 'pings'.
|
||||
* @type int $page Page ID to list comments for. Default empty.
|
||||
* @type int $per_page Number of comments to list per page. Default empty.
|
||||
* @type int $avatar_size Height and width dimensions of the avatar size. Default 32.
|
||||
* @type string $reverse_top_level Ordering of the listed comments. Default null. Accepts 'desc', 'asc'.
|
||||
* @type bool $reverse_children Whether to reverse child comments in the list. Default null.
|
||||
* @type string $format How to format the comments list.
|
||||
* Default 'html5' if the theme supports it. Accepts 'html5', 'xhtml'.
|
||||
* @type bool $short_ping Whether to output short pings. Default false.
|
||||
* @type bool $echo Whether to echo the output or return it. Default true.
|
||||
* }
|
||||
* @param array $comments Optional. Array of comment objects. @see WP_Query->comments
|
||||
* @param array $comments Optional. Array of comment objects.
|
||||
*/
|
||||
function wp_list_comments( $args = array(), $comments = null ) {
|
||||
global $wp_query, $comment_alt, $comment_depth, $comment_thread_alt, $overridden_cpage, $in_comment_loop;
|
||||
@ -1932,30 +1992,30 @@ function wp_list_comments( $args = array(), $comments = null ) {
|
||||
* @param array $args {
|
||||
* Optional. Default arguments and form fields to override.
|
||||
*
|
||||
* @type array 'fields' {
|
||||
* @type array $fields {
|
||||
* Default comment fields, filterable by default via the 'comment_form_default_fields' hook.
|
||||
*
|
||||
* @type string 'author' The comment author field HTML.
|
||||
* @type string 'email' The comment author email field HTML.
|
||||
* @type string 'url' The comment author URL field HTML.
|
||||
* @type string $author Comment author field HTML.
|
||||
* @type string $email Comment author email field HTML.
|
||||
* @type string $url Comment author URL field HTML.
|
||||
* }
|
||||
* @type string 'comment_field' The comment textarea field HTML.
|
||||
* @type string 'must_log_in' HTML element for a 'must be logged in to comment' message.
|
||||
* @type string 'logged_in_as' HTML element for a 'logged in as <user>' message.
|
||||
* @type string 'comment_notes_before' HTML element for a message displayed before the comment form.
|
||||
* Default 'Your email address will not be published.'.
|
||||
* @type string 'comment_notes_after' HTML element for a message displayed after the comment form.
|
||||
* Default 'You may use these HTML tags and attributes ...'.
|
||||
* @type string 'id_form' The comment form element id attribute. Default 'commentform'.
|
||||
* @type string 'id_submit' The comment submit element id attribute. Default 'submit'.
|
||||
* @type string 'title_reply' The translatable 'reply' button label. Default 'Leave a Reply'.
|
||||
* @type string 'title_reply_to' The translatable 'reply-to' button label. Default 'Leave a Reply to %s',
|
||||
* where %s is the author of the comment being replied to.
|
||||
* @type string 'cancel_reply_link' The translatable 'cancel reply' button label. Default 'Cancel reply'.
|
||||
* @type string 'label_submit' The translatable 'submit' button label. Default 'Post a comment'.
|
||||
* @type string 'format' The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.
|
||||
* @type string $comment_field The comment textarea field HTML.
|
||||
* @type string $must_log_in HTML element for a 'must be logged in to comment' message.
|
||||
* @type string $logged_in_as HTML element for a 'logged in as <user>' message.
|
||||
* @type string $comment_notes_before HTML element for a message displayed before the comment form.
|
||||
* Default 'Your email address will not be published.'.
|
||||
* @type string $comment_notes_after HTML element for a message displayed after the comment form.
|
||||
* Default 'You may use these HTML tags and attributes ...'.
|
||||
* @type string $id_form The comment form element id attribute. Default 'commentform'.
|
||||
* @type string $id_submit The comment submit element id attribute. Default 'submit'.
|
||||
* @type string $title_reply The translatable 'reply' button label. Default 'Leave a Reply'.
|
||||
* @type string $title_reply_to The translatable 'reply-to' button label. Default 'Leave a Reply to %s',
|
||||
* where %s is the author of the comment being replied to.
|
||||
* @type string $cancel_reply_link The translatable 'cancel reply' button label. Default 'Cancel reply'.
|
||||
* @type string $label_submit The translatable 'submit' button label. Default 'Post a comment'.
|
||||
* @type string $format The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.
|
||||
* }
|
||||
* @param int|WP_Post $post_id Optional. Post ID or WP_Post object to generate the form for. Default current post.
|
||||
* @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 )
|
||||
@ -2059,9 +2119,11 @@ function comment_form( $args = array(), $post_id = null ) {
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $args['logged_in_as'] The logged-in-as HTML-formatted message.
|
||||
* @param array $commenter An array containing the comment author's username, email, and URL.
|
||||
* @param string $user_identity If the commenter is a registered user, the display name, blank otherwise.
|
||||
* @param string $args_logged_in The logged-in-as HTML-formatted message.
|
||||
* @param array $commenter An array containing the comment author's
|
||||
* username, email, and URL.
|
||||
* @param string $user_identity If the commenter is a registered user,
|
||||
* the display name, blank otherwise.
|
||||
*/
|
||||
echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity );
|
||||
?>
|
||||
@ -2071,8 +2133,10 @@ function comment_form( $args = array(), $post_id = null ) {
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param array $commenter An array containing the comment author's username, email, and URL.
|
||||
* @param string $user_identity If the commenter is a registered user, the display name, blank otherwise.
|
||||
* @param array $commenter An array containing the comment author's
|
||||
* username, email, and URL.
|
||||
* @param string $user_identity If the commenter is a registered user,
|
||||
* the display name, blank otherwise.
|
||||
*/
|
||||
do_action( 'comment_form_logged_in_after', $commenter, $user_identity );
|
||||
?>
|
||||
@ -2112,7 +2176,7 @@ function comment_form( $args = array(), $post_id = null ) {
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $args['comment_field'] The content of the comment textarea field.
|
||||
* @param string $args_comment_field The content of the comment textarea field.
|
||||
*/
|
||||
echo apply_filters( 'comment_form_field_comment', $args['comment_field'] );
|
||||
?>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user