云策 WordPress 开发者社区

钩子文档

comment_form_submit_button

查看官方原文 ↗
💡 云策文档标注

概述

comment_form_submit_button 是一个 WordPress 过滤器，用于自定义评论表单的提交按钮的 HTML 标记。它允许开发者修改按钮的显示内容，例如添加额外的 HTML 元素或样式。

关键要点

  • 这是一个过滤器 Hook，用于过滤评论表单的提交按钮 HTML。
  • 接受两个参数：$submit_button（提交按钮的 HTML 字符串）和 $args（传递给 comment_form() 的参数数组）。
  • 开发者可以通过此 Hook 自定义提交按钮的标记，例如添加前后包装元素。
  • 与 comment_form() 函数紧密相关，用于输出完整的评论表单。

代码示例

// 定义 comment_form_submit_button 回调函数
function filter_comment_form_submit_button( $submit_button, $args ) {
    // 在此处进行过滤操作...
    $submit_before = '';
    $submit_after = '';
    return $submit_before . $submit_button . $submit_after;
};

// 添加过滤器
add_filter( 'comment_form_submit_button', 'filter_comment_form_submit_button', 10, 2 );
📄 原文内容

Filters the submit button for the comment form to display.

Parameters

$submit_buttonstring
HTML markup for the submit button.
$argsarray
Arguments passed to comment_form() .

More Arguments from comment_form( … $args )

Default arguments and form fields to override.

  • fields array
    Default comment fields, filterable by default via the ‘comment_form_default_fields’ hook.

    • author string
      Comment author field HTML.
    • email string
      Comment author email field HTML.
    • url string
      Comment author URL field HTML.
    • cookies string
      Comment cookie opt-in field HTML.
  • comment_field string
    The comment textarea field HTML.
  • must_log_in string
    HTML element for a ‘must be logged in to comment’ message.
  • logged_in_as string
    The HTML for the ‘logged in as [user]’ message, the Edit profile link, and the Log out link.
  • comment_notes_before string
    HTML element for a message displayed before the comment fields if the user is not logged in.
    Default ‘Your email address will not be published.’.
  • comment_notes_after string
    HTML element for a message displayed after the textarea field.
  • action string
    The comment form element action attribute. Default '/wp-comments-post.php'.
  • novalidate bool
    Whether the novalidate attribute is added to the comment form. Default false.
  • id_form string
    The comment form element id attribute. Default 'commentform'.
  • id_submit string
    The comment submit element id attribute. Default 'submit'.
  • class_container string
    The comment form container class attribute. Default 'comment-respond'.
  • class_form string
    The comment form element class attribute. Default 'comment-form'.
  • class_submit string
    The comment submit element class attribute. Default 'submit'.
  • name_submit string
    The comment submit element name attribute. Default 'submit'.
  • title_reply string
    The translatable 'reply' button label. Default ‘Leave a Reply’.
  • title_reply_to string
    The translatable 'reply-to' button label. Default ‘Leave a Reply to %s’, where %s is the author of the comment being replied to.
  • title_reply_before string
    HTML displayed before the comment form title.
    Default: <h3 id="reply-title" class="comment-reply-title">.
  • title_reply_after string
    HTML displayed after the comment form title.
    Default: <code></h3>.
  • cancel_reply_before string
    HTML displayed before the cancel reply link.
  • cancel_reply_after string
    HTML displayed after the cancel reply link.
  • cancel_reply_link string
    The translatable ‘cancel reply’ button label. Default ‘Cancel reply’.
  • label_submit string
    The translatable 'submit' button label. Default ‘Post a comment’.
  • submit_button string
    HTML format for the Submit button.
    Default: <input name="%1$s" type="submit" id="%2$s" class="%3$s" value="%4$s" />.
  • submit_field string
    HTML format for the markup surrounding the Submit button and comment hidden fields. Default: <p class="form-submit">%1$s %2$s</p>, where %1$s is the submit button markup and %2$s is the comment hidden fields.
  • format string
    The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.

Source

$submit_button = apply_filters( 'comment_form_submit_button', $submit_button, $args );

View all references View on Trac View on GitHub

Used by Description
comment_form()wp-includes/comment-template.php

Outputs a complete commenting form for use within a template.

Changelog

Version Description
4.2.0 Introduced.

User Contributed Notes

  1. Skip to note 2 content


    Prasad Nevase


    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

    Example: Following example shows how you can use this filter to change submit button markup of comment form.

    // define the comment_form_submit_button callback
function filter_comment_form_submit_button( $submit_button, $args ) {
    // make filter magic happen here...
    $submit_before = '<div class="form-group">';
    $submit_after = '</div>';
    return $submit_before . $submit_button . $submit_after;
};

// add the filter
add_filter( 'comment_form_submit_button', 'filter_comment_form_submit_button', 10, 2 );

You must log in before being able to contribute a note or feedback.