WordPress.org

Make WordPress Core

Changeset 25573


Ignore:
Timestamp:
09/23/2013 05:16:01 PM (5 years ago)
Author:
DrewAPicture
Message:

Improve inline documentation of arguments for comment_form().

See #25388.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/comment-template.php

    r25567 r25573  
    16411641 * @since 3.0.0
    16421642 *
    1643  * @todo Fully document $args
    1644  * @param array       $args    Optional. Options for strings, fields etc. in the form.
     1643 * @param array       $args {
     1644 *     Optional. Default arguments and form fields to override.
     1645 *
     1646 *     @type array 'fields' {
     1647 *         Default comment fields, filterable by default via the 'comment_form_default_fields' hook.
     1648 *
     1649 *         @type string 'author' The comment author field HTML.
     1650 *         @type string 'email'  The comment author email field HTML.
     1651 *         @type string 'url'    The comment author URL field HTML.
     1652 *     }
     1653 *     @type string 'comment_field'        The comment textarea field HTML.
     1654 *     @type string 'must_log_in'          HTML element for a 'must be logged in to comment' message.
     1655 *     @type string 'logged_in_as'         HTML element for a 'logged in as <user>' message.
     1656 *     @type string 'comment_notes_before' HTML element for a message displayed before the comment form.
     1657 *     @type string 'comment_notes_after'  HTML element for a message displayed after the comment form.
     1658 *     @type string 'id_form'              The comment form element id attribute.
     1659 *     @type string 'id_submit'            The comment submit element id attribute.
     1660 *     @type string 'title_reply'          The translatable 'reply' button label. Default 'Leave a Reply'.
     1661 *     @type string 'title_reply_to'       The translatable 'reply-to' button label. Default 'Leave a Reply to %s',
     1662 *                                         where %s is the author of the comment being replied to.
     1663 *     @type string 'cancel_reply_link'    The translatable 'cancel reply' button label. Default 'Cancel reply'.
     1664 *     @type string 'label_submit'         The translatable 'submit' button label. Default 'Post a comment'.
     1665 *     @type string 'format'               The comment form format. Default 'xhtml'. Accepts 'xhtml', 'html5'.
     1666 * }
    16451667 * @param int|WP_Post $post_id Optional. Post ID or WP_Post object to generate the form for. Default current post.
    16461668 */
Note: See TracChangeset for help on using the changeset viewer.