Docs: Fix placement of some duplicate hook references.
Hook documentation should be on the line directly above the line containing the `do_action()` or `apply_filters()` call. The CS auto-fixing, which changed some inconsistent function calls to multi-line function calls, is part of the reason why this was no longer the case for a select group of duplicate hook references. Includes minor code layout fixes. See #47110. Built from https://develop.svn.wordpress.org/trunk@46088 git-svn-id: http://core.svn.wordpress.org/trunk@45900 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
@@ -2274,19 +2274,63 @@ function comment_form( $args = array(), $post_id = null ) {
|
||||
$req = get_option( 'require_name_email' );
|
||||
$html_req = ( $req ? " required='required'" : '' );
|
||||
$html5 = 'html5' === $args['format'];
|
||||
$fields = array(
|
||||
'author' => '<p class="comment-form-author">' . '<label for="author">' . __( 'Name' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
|
||||
'<input id="author" name="author" type="text" value="' . esc_attr( $commenter['comment_author'] ) . '" size="30" maxlength="245"' . $html_req . ' /></p>',
|
||||
'email' => '<p class="comment-form-email"><label for="email">' . __( 'Email' ) . ( $req ? ' <span class="required">*</span>' : '' ) . '</label> ' .
|
||||
'<input id="email" name="email" ' . ( $html5 ? 'type="email"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_email'] ) . '" size="30" maxlength="100" aria-describedby="email-notes"' . $html_req . ' /></p>',
|
||||
'url' => '<p class="comment-form-url"><label for="url">' . __( 'Website' ) . '</label> ' .
|
||||
'<input id="url" name="url" ' . ( $html5 ? 'type="url"' : 'type="text"' ) . ' value="' . esc_attr( $commenter['comment_author_url'] ) . '" size="30" maxlength="200" /></p>',
|
||||
|
||||
$fields = array(
|
||||
'author' => sprintf(
|
||||
'<p class="comment-form-author">%s %s</p>',
|
||||
sprintf(
|
||||
'<label for="author">%s%s</label>',
|
||||
__( 'Name' ),
|
||||
( $req ? ' <span class="required">*</span>' : '' )
|
||||
),
|
||||
sprintf(
|
||||
'<input id="author" name="author" type="text" value="%s" size="30" maxlength="245"%s />',
|
||||
esc_attr( $commenter['comment_author'] ),
|
||||
$html_req
|
||||
)
|
||||
),
|
||||
'email' => sprintf(
|
||||
'<p class="comment-form-email">%s %s</p>',
|
||||
sprintf(
|
||||
'<label for="email">%s%s</label>',
|
||||
__( 'Email' ),
|
||||
( $req ? ' <span class="required">*</span>' : '' )
|
||||
),
|
||||
sprintf(
|
||||
'<input id="email" name="email" %s value="%s" size="30" maxlength="100" aria-describedby="email-notes"%s />',
|
||||
( $html5 ? 'type="email"' : 'type="text"' ),
|
||||
esc_attr( $commenter['comment_author_email'] ),
|
||||
$html_req
|
||||
)
|
||||
),
|
||||
'url' => sprintf(
|
||||
'<p class="comment-form-url">%s %s</p>',
|
||||
sprintf(
|
||||
'<label for="url">%s</label>',
|
||||
__( 'Website' )
|
||||
),
|
||||
sprintf(
|
||||
'<input id="url" name="url" %s value="%s" size="30" maxlength="200" />',
|
||||
( $html5 ? 'type="url"' : 'type="text"' ),
|
||||
esc_attr( $commenter['comment_author_url'] )
|
||||
)
|
||||
),
|
||||
);
|
||||
|
||||
if ( has_action( 'set_comment_cookies', 'wp_set_comment_cookies' ) && get_option( 'show_comments_cookies_opt_in' ) ) {
|
||||
$consent = empty( $commenter['comment_author_email'] ) ? '' : ' checked="checked"';
|
||||
$fields['cookies'] = '<p class="comment-form-cookies-consent"><input id="wp-comment-cookies-consent" name="wp-comment-cookies-consent" type="checkbox" value="yes"' . $consent . ' />' .
|
||||
'<label for="wp-comment-cookies-consent">' . __( 'Save my name, email, and website in this browser for the next time I comment.' ) . '</label></p>';
|
||||
$consent = empty( $commenter['comment_author_email'] ) ? '' : ' checked="checked"';
|
||||
|
||||
$fields['cookies'] = sprintf(
|
||||
'<p class="comment-form-cookies-consent">%s %s</p>',
|
||||
sprintf(
|
||||
'<input id="wp-comment-cookies-consent" name="wp-comment-cookies-consent" type="checkbox" value="yes"%s />',
|
||||
$consent
|
||||
),
|
||||
sprintf(
|
||||
'<label for="wp-comment-cookies-consent">%s</label>',
|
||||
__( 'Save my name, email, and website in this browser for the next time I comment.' )
|
||||
)
|
||||
);
|
||||
|
||||
// Ensure that the passed fields include cookies consent.
|
||||
if ( isset( $args['fields'] ) && ! isset( $args['fields']['cookies'] ) ) {
|
||||
@@ -2307,27 +2351,48 @@ function comment_form( $args = array(), $post_id = null ) {
|
||||
*
|
||||
* @param string[] $fields Array of the default comment fields.
|
||||
*/
|
||||
$fields = apply_filters( 'comment_form_default_fields', $fields );
|
||||
$fields = apply_filters( 'comment_form_default_fields', $fields );
|
||||
|
||||
$defaults = array(
|
||||
'fields' => $fields,
|
||||
'comment_field' => '<p class="comment-form-comment"><label for="comment">' . _x( 'Comment', 'noun' ) . '</label> <textarea id="comment" name="comment" cols="45" rows="8" maxlength="65525" required="required"></textarea></p>',
|
||||
/** This filter is documented in wp-includes/link-template.php */
|
||||
'must_log_in' => '<p class="must-log-in">' . sprintf(
|
||||
/* translators: %s: Login URL. */
|
||||
__( 'You must be <a href="%s">logged in</a> to post a comment.' ),
|
||||
wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) )
|
||||
) . '</p>',
|
||||
/** This filter is documented in wp-includes/link-template.php */
|
||||
'logged_in_as' => '<p class="logged-in-as">' . sprintf(
|
||||
/* translators: 1: Edit user link, 2: Accessibility text, 3: User name, 4: Logout URL. */
|
||||
__( '<a href="%1$s" aria-label="%2$s">Logged in as %3$s</a>. <a href="%4$s">Log out?</a>' ),
|
||||
get_edit_user_link(),
|
||||
/* translators: %s: User name. */
|
||||
esc_attr( sprintf( __( 'Logged in as %s. Edit your profile.' ), $user_identity ) ),
|
||||
$user_identity,
|
||||
wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) )
|
||||
) . '</p>',
|
||||
'comment_notes_before' => '<p class="comment-notes"><span id="email-notes">' . __( 'Your email address will not be published.' ) . '</span>' . ( $req ? $required_text : '' ) . '</p>',
|
||||
'comment_field' => sprintf(
|
||||
'<p class="comment-form-comment">%s %s</p>',
|
||||
sprintf(
|
||||
'<label for="comment">%s</label>',
|
||||
_x( 'Comment', 'noun' )
|
||||
),
|
||||
'<textarea id="comment" name="comment" cols="45" rows="8" maxlength="65525" required="required"></textarea>'
|
||||
),
|
||||
'must_log_in' => sprintf(
|
||||
'<p class="must-log-in">%s</p>',
|
||||
sprintf(
|
||||
/* translators: %s: Login URL. */
|
||||
__( 'You must be <a href="%s">logged in</a> to post a comment.' ),
|
||||
/** This filter is documented in wp-includes/link-template.php */
|
||||
wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) )
|
||||
)
|
||||
),
|
||||
'logged_in_as' => sprintf(
|
||||
'<p class="logged-in-as">%s</p>',
|
||||
sprintf(
|
||||
/* translators: 1: Edit user link, 2: Accessibility text, 3: User name, 4: Logout URL. */
|
||||
__( '<a href="%1$s" aria-label="%2$s">Logged in as %3$s</a>. <a href="%4$s">Log out?</a>' ),
|
||||
get_edit_user_link(),
|
||||
/* translators: %s: User name. */
|
||||
esc_attr( sprintf( __( 'Logged in as %s. Edit your profile.' ), $user_identity ) ),
|
||||
$user_identity,
|
||||
/** This filter is documented in wp-includes/link-template.php */
|
||||
wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) )
|
||||
)
|
||||
),
|
||||
'comment_notes_before' => sprintf(
|
||||
'<p class="comment-notes">%s%s</p>',
|
||||
sprintf(
|
||||
'<span id="email-notes">%s</span>',
|
||||
__( 'Your email address will not be published.' )
|
||||
),
|
||||
( $req ? $required_text : '' )
|
||||
),
|
||||
'comment_notes_after' => '',
|
||||
'action' => site_url( '/wp-comments-post.php' ),
|
||||
'id_form' => 'commentform',
|
||||
@@ -2385,6 +2450,7 @@ function comment_form( $args = array(), $post_id = null ) {
|
||||
echo $args['title_reply_after'];
|
||||
|
||||
if ( get_option( 'comment_registration' ) && ! is_user_logged_in() ) :
|
||||
|
||||
echo $args['must_log_in'];
|
||||
/**
|
||||
* Fires after the HTML-formatted 'must log in after' message in the comment form.
|
||||
@@ -2392,165 +2458,175 @@ function comment_form( $args = array(), $post_id = null ) {
|
||||
* @since 3.0.0
|
||||
*/
|
||||
do_action( 'comment_form_must_log_in_after' );
|
||||
|
||||
else :
|
||||
?>
|
||||
<form action="<?php echo esc_url( $args['action'] ); ?>" method="post" id="<?php echo esc_attr( $args['id_form'] ); ?>" class="<?php echo esc_attr( $args['class_form'] ); ?>"<?php echo $html5 ? ' novalidate' : ''; ?>>
|
||||
<?php
|
||||
|
||||
printf(
|
||||
'<form action="%s" method="post" id="%s" class="%s"%s>',
|
||||
esc_url( $args['action'] ),
|
||||
esc_attr( $args['id_form'] ),
|
||||
esc_attr( $args['class_form'] ),
|
||||
( $html5 ? ' novalidate' : '' )
|
||||
);
|
||||
|
||||
/**
|
||||
* Fires at the top of the comment form, inside the form tag.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
do_action( 'comment_form_top' );
|
||||
|
||||
if ( is_user_logged_in() ) :
|
||||
|
||||
/**
|
||||
* Fires at the top of the comment form, inside the form tag.
|
||||
* Filters the 'logged in' message for the comment form for display.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @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.
|
||||
*/
|
||||
do_action( 'comment_form_top' );
|
||||
|
||||
if ( is_user_logged_in() ) :
|
||||
/**
|
||||
* Filters the 'logged in' message for the comment form for display.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @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 );
|
||||
|
||||
/**
|
||||
* Fires after the is_user_logged_in() check in the comment form.
|
||||
*
|
||||
* @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.
|
||||
*/
|
||||
do_action( 'comment_form_logged_in_after', $commenter, $user_identity );
|
||||
|
||||
else :
|
||||
|
||||
echo $args['comment_notes_before'];
|
||||
|
||||
endif;
|
||||
|
||||
// Prepare an array of all fields, including the textarea
|
||||
$comment_fields = array( 'comment' => $args['comment_field'] ) + (array) $args['fields'];
|
||||
echo apply_filters( 'comment_form_logged_in', $args['logged_in_as'], $commenter, $user_identity );
|
||||
|
||||
/**
|
||||
* Filters the comment form fields, including the textarea.
|
||||
* Fires after the is_user_logged_in() check in the comment form.
|
||||
*
|
||||
* @since 4.4.0
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param array $comment_fields The comment fields.
|
||||
* @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.
|
||||
*/
|
||||
$comment_fields = apply_filters( 'comment_form_fields', $comment_fields );
|
||||
do_action( 'comment_form_logged_in_after', $commenter, $user_identity );
|
||||
|
||||
// Get an array of field names, excluding the textarea
|
||||
$comment_field_keys = array_diff( array_keys( $comment_fields ), array( 'comment' ) );
|
||||
else :
|
||||
|
||||
// Get the first and the last field name, excluding the textarea
|
||||
$first_field = reset( $comment_field_keys );
|
||||
$last_field = end( $comment_field_keys );
|
||||
echo $args['comment_notes_before'];
|
||||
|
||||
foreach ( $comment_fields as $name => $field ) {
|
||||
endif;
|
||||
|
||||
if ( 'comment' === $name ) {
|
||||
// Prepare an array of all fields, including the textarea
|
||||
$comment_fields = array( 'comment' => $args['comment_field'] ) + (array) $args['fields'];
|
||||
|
||||
/**
|
||||
* Filters the comment form fields, including the textarea.
|
||||
*
|
||||
* @since 4.4.0
|
||||
*
|
||||
* @param array $comment_fields The comment fields.
|
||||
*/
|
||||
$comment_fields = apply_filters( 'comment_form_fields', $comment_fields );
|
||||
|
||||
// Get an array of field names, excluding the textarea
|
||||
$comment_field_keys = array_diff( array_keys( $comment_fields ), array( 'comment' ) );
|
||||
|
||||
// Get the first and the last field name, excluding the textarea
|
||||
$first_field = reset( $comment_field_keys );
|
||||
$last_field = end( $comment_field_keys );
|
||||
|
||||
foreach ( $comment_fields as $name => $field ) {
|
||||
|
||||
if ( 'comment' === $name ) {
|
||||
|
||||
/**
|
||||
* Filters the content of the comment textarea field for display.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $args_comment_field The content of the comment textarea field.
|
||||
*/
|
||||
echo apply_filters( 'comment_form_field_comment', $field );
|
||||
|
||||
echo $args['comment_notes_after'];
|
||||
|
||||
} elseif ( ! is_user_logged_in() ) {
|
||||
|
||||
if ( $first_field === $name ) {
|
||||
/**
|
||||
* Filters the content of the comment textarea field for display.
|
||||
* Fires before the comment fields in the comment form, excluding the textarea.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $args_comment_field The content of the comment textarea field.
|
||||
*/
|
||||
echo apply_filters( 'comment_form_field_comment', $field );
|
||||
do_action( 'comment_form_before_fields' );
|
||||
}
|
||||
|
||||
echo $args['comment_notes_after'];
|
||||
|
||||
} elseif ( ! is_user_logged_in() ) {
|
||||
|
||||
if ( $first_field === $name ) {
|
||||
/**
|
||||
* Fires before the comment fields in the comment form, excluding the textarea.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
do_action( 'comment_form_before_fields' );
|
||||
}
|
||||
/**
|
||||
* Filters a comment form field for display.
|
||||
*
|
||||
* The dynamic portion of the filter hook, `$name`, refers to the name
|
||||
* of the comment form field. Such as 'author', 'email', or 'url'.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $field The HTML-formatted output of the comment form field.
|
||||
*/
|
||||
echo apply_filters( "comment_form_field_{$name}", $field ) . "\n";
|
||||
|
||||
if ( $last_field === $name ) {
|
||||
/**
|
||||
* Filters a comment form field for display.
|
||||
*
|
||||
* The dynamic portion of the filter hook, `$name`, refers to the name
|
||||
* of the comment form field. Such as 'author', 'email', or 'url'.
|
||||
* Fires after the comment fields in the comment form, excluding the textarea.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $field The HTML-formatted output of the comment form field.
|
||||
*/
|
||||
echo apply_filters( "comment_form_field_{$name}", $field ) . "\n";
|
||||
|
||||
if ( $last_field === $name ) {
|
||||
/**
|
||||
* Fires after the comment fields in the comment form, excluding the textarea.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
do_action( 'comment_form_after_fields' );
|
||||
}
|
||||
do_action( 'comment_form_after_fields' );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$submit_button = sprintf(
|
||||
$args['submit_button'],
|
||||
esc_attr( $args['name_submit'] ),
|
||||
esc_attr( $args['id_submit'] ),
|
||||
esc_attr( $args['class_submit'] ),
|
||||
esc_attr( $args['label_submit'] )
|
||||
);
|
||||
$submit_button = sprintf(
|
||||
$args['submit_button'],
|
||||
esc_attr( $args['name_submit'] ),
|
||||
esc_attr( $args['id_submit'] ),
|
||||
esc_attr( $args['class_submit'] ),
|
||||
esc_attr( $args['label_submit'] )
|
||||
);
|
||||
|
||||
/**
|
||||
* Filters the submit button for the comment form to display.
|
||||
*
|
||||
* @since 4.2.0
|
||||
*
|
||||
* @param string $submit_button HTML markup for the submit button.
|
||||
* @param array $args Arguments passed to comment_form().
|
||||
*/
|
||||
$submit_button = apply_filters( 'comment_form_submit_button', $submit_button, $args );
|
||||
/**
|
||||
* Filters the submit button for the comment form to display.
|
||||
*
|
||||
* @since 4.2.0
|
||||
*
|
||||
* @param string $submit_button HTML markup for the submit button.
|
||||
* @param array $args Arguments passed to comment_form().
|
||||
*/
|
||||
$submit_button = apply_filters( 'comment_form_submit_button', $submit_button, $args );
|
||||
|
||||
$submit_field = sprintf(
|
||||
$args['submit_field'],
|
||||
$submit_button,
|
||||
get_comment_id_fields( $post_id )
|
||||
);
|
||||
$submit_field = sprintf(
|
||||
$args['submit_field'],
|
||||
$submit_button,
|
||||
get_comment_id_fields( $post_id )
|
||||
);
|
||||
|
||||
/**
|
||||
* Filters the submit field for the comment form to display.
|
||||
*
|
||||
* The submit field includes the submit button, hidden fields for the
|
||||
* comment form, and any wrapper markup.
|
||||
*
|
||||
* @since 4.2.0
|
||||
*
|
||||
* @param string $submit_field HTML markup for the submit field.
|
||||
* @param array $args Arguments passed to comment_form().
|
||||
*/
|
||||
echo apply_filters( 'comment_form_submit_field', $submit_field, $args );
|
||||
/**
|
||||
* Filters the submit field for the comment form to display.
|
||||
*
|
||||
* The submit field includes the submit button, hidden fields for the
|
||||
* comment form, and any wrapper markup.
|
||||
*
|
||||
* @since 4.2.0
|
||||
*
|
||||
* @param string $submit_field HTML markup for the submit field.
|
||||
* @param array $args Arguments passed to comment_form().
|
||||
*/
|
||||
echo apply_filters( 'comment_form_submit_field', $submit_field, $args );
|
||||
|
||||
/**
|
||||
* Fires at the bottom of the comment form, inside the closing </form> tag.
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $post_id The post ID.
|
||||
*/
|
||||
do_action( 'comment_form', $post_id );
|
||||
?>
|
||||
</form>
|
||||
<?php endif; ?>
|
||||
/**
|
||||
* Fires at the bottom of the comment form, inside the closing </form> tag.
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param int $post_id The post ID.
|
||||
*/
|
||||
do_action( 'comment_form', $post_id );
|
||||
|
||||
echo '</form>';
|
||||
|
||||
endif;
|
||||
?>
|
||||
</div><!-- #respond -->
|
||||
<?php
|
||||
|
||||
|
||||
Reference in New Issue
Block a user