Changeset 33811 for trunk/src/wp-includes/comment-functions.php

Timestamp:

08/30/2015 03:20:24 AM (9 years ago)

Author:

wonderboymusic

Message:

Fix the doc block syntax for the 'wp_get_current_commenter' filter.

Props dimadin.
Fixes #33304.

File:

• trunk/src/wp-includes/comment-functions.php (modified) (1 diff)

trunk/src/wp-includes/comment-functions.php

@@ -1355 +1355 @@
      * @since 3.1.0
      *
-     * @param string $comment_author       Comment author's name.
-     * @param string $comment_author_email Comment author's email.
-     * @param string $comment_author_url   Comment author's URL.
+     * @param array $comment_author_data {
+     *     An array of current commenter variables.
+     *
+     *     @type string $comment_author       The name of the author of the comment. Default empty.
+     *     @type string $comment_author_email The email address of the `$comment_author`. Default empty.
+     *     @type string $comment_author_url   The URL address of the `$comment_author`. Default empty.
+     * }
      */
     return apply_filters( 'wp_get_current_commenter', compact('comment_author', 'comment_author_email', 'comment_author_url') );