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

Timestamp:

11/08/2014 08:35:00 PM (10 years ago)

Author:

DrewAPicture

Message:

Cross-reference WP_Comment_Query::query() as the location for finding information on default arguments for WP_Comment_Query.

Also updates the return types on get_comments() and get_approved_comments(), as an integer can also be returned if the $count argument is true.

Fixes #30111.

File:

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

trunk/src/wp-includes/comment.php

@@ -132 +132 @@
  *
  * @param  int   $post_id The ID of the post.
- * @param  array $args    Optional. See {@see WP_Comment_Query} for information
+ * @param  array $args    Optional. See {@see WP_Comment_Query::query()} for information
  *                        on accepted arguments.
- * @return array $comments The approved comments.
+ * @return int|array $comments The approved comments, or number of comments if `$count`
+ *                             argument is true.
  */
 function get_approved_comments( $post_id = 0, $args = array() ) {
@@ -212 +213 @@
  * The comment list can be for the blog as a whole or for an individual post.
  *
- * The list of comment arguments are 'status', 'orderby', 'comment_date_gmt',
- * 'order', 'number', 'offset', and 'post_id'.
- *
  * @since 2.7.0
  *
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param mixed $args Optional. Array or string of options to override defaults.
- * @return array List of comments.
+ * @param string|array $args Optional. Array or string of arguments. See {@see WP_Comment_Query::query()}
+ *                           for information on accepted arguments. Default empty.
+ * @return int|array List of comments or number of found comments if `$count` argument is true.
  */
 function get_comments( $args = '' ) {
@@ -229 +228 @@
 /**
  * WordPress Comment Query class.
+ *
+ * See {@see WP_Comment_Query::query()} for accepted arguments.
  *
  * @since 3.1.0