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

See #48303


git-svn-id: https://develop.svn.wordpress.org/trunk@46660 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2019-11-05 21:21:46 +00:00
parent 63d4dcd10a
commit db4f746b4a
31 changed files with 177 additions and 119 deletions
+11 -3
View File
@@ -859,9 +859,17 @@ function _update_posts_count_on_transition_post_status( $new_status, $old_status
*
* @since 5.3.0
*
* @param int $network_id The network to get counts for. Default is the current network id.
* @return array Includes a grand total 'all' and an array of counts indexed by
* status strings: public, archived, mature, spam, deleted.
* @param int $network_id Optional. The network to get counts for. Default is the current network ID.
* @return int[] {
* Numbers of sites grouped by site status.
*
* @type int $all The total number of sites.
* @type int $public The number of public sites.
* @type int $archived The number of archived sites.
* @type int $mature The number of mature sites.
* @type int $spam The number of spam sites.
* @type int $deleted The number of deleted sites.
* }
*/
function wp_count_sites( $network_id = null ) {
if ( empty( $network_id ) ) {