Make WordPress Core


Ignore:
Timestamp:
05/23/2016 06:58:48 PM (7 years ago)
Author:
DrewAPicture
Message:

Docs: Apply inline @see tags to hooks referenced in DocBlocks in a variety of wp-includes/* files.

Applying these specially-crafted @see tags allows the Code Reference parser to recognize and link these elements as actions and filters.

See #36921.

File:
1 edited

Legend:

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

    r37497 r37542  
    12401240 *
    12411241 * Uses the WordPress database object to query for the comments. The comments
    1242  * are passed through the 'comments_array' filter hook with the list of comments
     1242 * are passed through the {@see 'comments_array'} filter hook with the list of comments
    12431243 * and the post ID respectively.
    12441244 *
    1245  * The $file path is passed through a filter hook called, 'comments_template'
     1245 * The `$file` path is passed through a filter hook called {@see 'comments_template'},
    12461246 * which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
    12471247 * first and if it fails it will require the default comment template from the
     
    20702070
    20712071/**
    2072  * Output a complete commenting form for use within a template.
     2072 * Outputs a complete commenting form for use within a template.
    20732073 *
    20742074 * Most strings and form fields may be controlled through the $args array passed
    2075  * into the function, while you may also choose to use the comment_form_default_fields
     2075 * into the function, while you may also choose to use the {@see 'comment_form_default_fields'}
    20762076 * filter to modify the array of default fields if you'd just like to add a new
    20772077 * one or remove a single field. All fields are also individually passed through
    2078  * a filter of the form comment_form_field_$name where $name is the key used
     2078 * a filter of the {@see 'form comment_form_field_$name'} where $name is the key used
    20792079 * in the array of fields.
    20802080 *
     
    20922092 *
    20932093 *     @type array $fields {
    2094  *         Default comment fields, filterable by default via the 'comment_form_default_fields' hook.
     2094 *         Default comment fields, filterable by default via the {@see 'comment_form_default_fields'} hook.
    20952095 *
    20962096 *         @type string $author Comment author field HTML.
     
    22092209     * Filters the comment form default arguments.
    22102210     *
    2211      * Use 'comment_form_default_fields' to filter the comment fields.
     2211     * Use {@see 'comment_form_default_fields'} to filter the comment fields.
    22122212     *
    22132213     * @since 3.0.0
Note: See TracChangeset for help on using the changeset viewer.