Changeset 36070 for trunk/src/wp-admin/includes/deprecated.php

Timestamp:

12/23/2015 06:52:15 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Properly mark the $exclude_zeros parameter in the DocBlock for get_editable_user_ids() as optional.

Also fixes a couple of typos.

See #32246.

File:

• trunk/src/wp-admin/includes/deprecated.php (modified) (1 diff)

trunk/src/wp-admin/includes/deprecated.php

@@ -267 +267 @@
  * @deprecated 3.1.0 Use get_users()
  *
- * @param int $user_id User ID.
- * @param bool $exclude_zeros Optional, default is true. Whether to exclude zeros.
- * @return mixed
+ * @param int  $user_id       User ID.
+ * @param bool $exclude_zeros Optional. Whether to exclude zeroes. Default true.
+ * @return array Array of editable user IDs, empty array otherwise.
  */
 function get_editable_user_ids( $user_id, $exclude_zeros = true, $post_type = 'post' ) {