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.


git-svn-id: https://develop.svn.wordpress.org/trunk@36070 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-12-23 06:52:15 +00:00
parent a6556195d8
commit b489587419
1 changed files with 3 additions and 3 deletions

View File

@ -266,9 +266,9 @@ function get_editable_authors( $user_id ) {
*
* @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' ) {
_deprecated_function( __FUNCTION__, '3.1', 'get_users()' );