Changeset 46660 for trunk/src/wp-includes/comment.php

Timestamp:

11/05/2019 09:21:46 PM (6 years ago)

Author:

johnbillion

Message:

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

See #48303

File:

• trunk/src/wp-includes/comment.php (modified) (5 diffs)

trunk/src/wp-includes/comment.php

@@ -252 +252 @@
  * @since 2.7.0
  *
- * @return array List of comment statuses.
+ * @return string[] List of comment status labels keyed by status.
  */
 function get_comment_statuses() {
@@ -1164 +1164 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @return array Maximum character length for the comment form fields.
+ * @return int[] Array of maximum lengths keyed by field name.
  */
 function wp_get_comment_fields_max_lengths() {
@@ -1207 +1207 @@
      * @since 4.5.0
      *
-     * @param array $lengths Associative array `'field_name' => 'maximum length'`.
+     * @param int[] $lengths Array of maximum lengths keyed by field name.
      */
     return apply_filters( 'wp_get_comment_fields_max_lengths', $lengths );
@@ -1779 +1779 @@
  * @since 2.0.4
  *
- * @return array Comment author, email, url respectively.
+ * @return array {
+ *     An array of current commenter variables.
+ *
+ *     @type string $comment_author       The name of the current commenter, or an empty string.
+ *     @type string $comment_author_email The email address of the current commenter, or an empty string.
+ *     @type string $comment_author_url   The URL address of the current commenter, or an empty string.
+ * }
  */
 function wp_get_current_commenter() {
@@ -1807 +1813 @@
      *     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.
+     *     @type string $comment_author       The name of the current commenter, or an empty string.
+     *     @type string $comment_author_email The email address of the current commenter, or an empty string.
+     *     @type string $comment_author_url   The URL address of the current commenter, or an empty string.
      * }
      */