WordPress.org

Make WordPress Core


Ignore:
Timestamp:
11/05/2019 09:21:46 PM (18 months ago)
Author:
johnbillion
Message:

Docs: Improve documentation of known return types, plus other docs fixes.

See #48303

File:
1 edited

Legend:

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

    r46644 r46660  
    252252 * @since 2.7.0
    253253 *
    254  * @return array List of comment statuses.
     254 * @return string[] List of comment status labels keyed by status.
    255255 */
    256256function get_comment_statuses() {
     
    11641164 * @global wpdb $wpdb WordPress database abstraction object.
    11651165 *
    1166  * @return array Maximum character length for the comment form fields.
     1166 * @return int[] Array of maximum lengths keyed by field name.
    11671167 */
    11681168function wp_get_comment_fields_max_lengths() {
     
    12071207     * @since 4.5.0
    12081208     *
    1209      * @param array $lengths Associative array `'field_name' => 'maximum length'`.
     1209     * @param int[] $lengths Array of maximum lengths keyed by field name.
    12101210     */
    12111211    return apply_filters( 'wp_get_comment_fields_max_lengths', $lengths );
     
    17791779 * @since 2.0.4
    17801780 *
    1781  * @return array Comment author, email, url respectively.
     1781 * @return array {
     1782 *     An array of current commenter variables.
     1783 *
     1784 *     @type string $comment_author       The name of the current commenter, or an empty string.
     1785 *     @type string $comment_author_email The email address of the current commenter, or an empty string.
     1786 *     @type string $comment_author_url   The URL address of the current commenter, or an empty string.
     1787 * }
    17821788 */
    17831789function wp_get_current_commenter() {
     
    18071813     *     An array of current commenter variables.
    18081814     *
    1809      *     @type string $comment_author       The name of the author of the comment. Default empty.
    1810      *     @type string $comment_author_email The email address of the `$comment_author`. Default empty.
    1811      *     @type string $comment_author_url   The URL address of the `$comment_author`. Default empty.
     1815     *     @type string $comment_author       The name of the current commenter, or an empty string.
     1816     *     @type string $comment_author_email The email address of the current commenter, or an empty string.
     1817     *     @type string $comment_author_url   The URL address of the current commenter, or an empty string.
    18121818     * }
    18131819     */
Note: See TracChangeset for help on using the changeset viewer.