Docs: Fix backwards default value for wp_list_users()::exclude_admin.#11022
Docs: Fix backwards default value for wp_list_users()::exclude_admin.#11022dmsnell wants to merge 1 commit intoWordPress:trunkfrom
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
dmsnell
force-pushed
the
docs-fix-wp-list-users-exclude-admin
branch
from
5a7cb83 to
1201f39
Compare
| * @type string $order Sorting direction for $orderby. Accepts 'ASC', 'DESC'. Default 'ASC'. | ||
| * @type int $number Maximum users to return or display. Default empty (all users). | ||
| * @type bool $exclude_admin Whether to exclude the 'admin' account, if it exists. Default false. | ||
| * @type bool $exclude_admin Whether to exclude the 'admin' account, if it exists. Default true. |
There was a problem hiding this comment.
I reviewed this change and cross-referenced it with the actual implementation in src/wp-includes/user.php
On line 918, the $defaults array explicitly sets 'exclude_admin' => true, which confirms that the current DocBlock on line 897 was indeed incorrect (backwards). This update correctly aligns the documentation with the actual behavior of the function. Happy to see this being fixed!
dmsnell
force-pushed
the
docs-fix-wp-list-users-exclude-admin
branch
from
1201f39 to
81db7b1
Compare
|
just to update those tagging on to this ticket now; it would have been merged yesterday except for the flakey end-to-end tests which are failing. as soon as those pass and I’m around to do it, I will merge. |
dmsnell
force-pushed
the
docs-fix-wp-list-users-exclude-admin
branch
2 times, most recently
from
2b37e7c to
c169076
Compare
See: WordPress/Documentation-Issue-Tracker#1849 This was previosly listed as defaulting to `false` when in fact it defaults to `true.` Co-Authored-By: Philip <vHeemstra@git.wordpress.org>
dmsnell
force-pushed
the
docs-fix-wp-list-users-exclude-admin
branch
from
c169076 to
f2e55ed
Compare
This was previosly listed as defaulting to `false` when in fact it defaults to `true.` Developed in: #11022 Discussed in: https://core.trac.wordpress.org/ticket/64224 Reported in: WordPress/Documentation-Issue-Tracker#1849 Props dmsnell, noruzzaman, vHeemstra, westonruter. See #64224. git-svn-id: https://develop.svn.wordpress.org/trunk@61735 602fd350-edb4-49c9-b593-d223f7449a82
This was previosly listed as defaulting to `false` when in fact it defaults to `true.` Developed in: WordPress/wordpress-develop#11022 Discussed in: https://core.trac.wordpress.org/ticket/64224 Reported in: WordPress/Documentation-Issue-Tracker#1849 Props dmsnell, noruzzaman, vHeemstra, westonruter. See #64224. Built from https://develop.svn.wordpress.org/trunk@61735 git-svn-id: http://core.svn.wordpress.org/trunk@61042 1a063a9b-81f0-0310-95a4-ce76da25c4cd
3 participants
Trac ticket: Core-64224
Resolves: WordPress/Documentation-Issue-Tracker#1849
This was previosly listed as defaulting to
falsewhen in fact it defaults totrue.As this is a documentation-only change it should include no code or functionality changes.