From f404ff34c0ce1b9fab35635f6b92f299a1442c7f Mon Sep 17 00:00:00 2001 From: Jb Audras Date: Sun, 13 Nov 2022 23:17:47 +0000 Subject: [PATCH] Docs: Various docblock fixes in Multisite administration functions. See #56792. git-svn-id: https://develop.svn.wordpress.org/trunk@54833 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/ms.php | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/wp-admin/includes/ms.php b/src/wp-admin/includes/ms.php index dc6a145549..8b98c229db 100644 --- a/src/wp-admin/includes/ms.php +++ b/src/wp-admin/includes/ms.php @@ -8,7 +8,7 @@ */ /** - * Determine if uploaded file exceeds space quota. + * Determines whether uploaded file exceeds space quota. * * @since 3.0.0 * @@ -53,7 +53,7 @@ function check_upload_size( $file ) { } /** - * Delete a site. + * Deletes a site. * * @since 3.0.0 * @since 5.1.0 Use wp_delete_site() internally to delete the site row from the database. @@ -130,7 +130,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) { } /** - * Delete a user from the network and remove from all sites. + * Deletes a user from the network and remove from all sites. * * @since 3.0.0 * @@ -139,7 +139,7 @@ function wpmu_delete_blog( $blog_id, $drop = false ) { * @global wpdb $wpdb WordPress database abstraction object. * * @param int $id The user ID. - * @return bool True if the user was deleted, otherwise false. + * @return bool True if the user was deleted, false otherwise. */ function wpmu_delete_user( $id ) { global $wpdb; @@ -213,7 +213,7 @@ function wpmu_delete_user( $id ) { } /** - * Check whether a site has used its allotted upload space. + * Checks whether a site has used its allotted upload space. * * @since MU (3.0.0) * @@ -269,12 +269,12 @@ function display_space_usage() { } /** - * Get the remaining upload space for this site. + * Gets the remaining upload space for this site. * * @since MU (3.0.0) * - * @param int $size Current max size in bytes - * @return int Max size in bytes + * @param int $size Current max size in bytes. + * @return int Max size in bytes. */ function fix_import_form_size( $size ) { if ( upload_is_user_over_quota( false ) ) { @@ -793,7 +793,7 @@ function choose_primary_blog() { } /** - * Whether or not we can edit this network from this page. + * Determines whether or not this network from this page can be edited. * * By default editing of network is restricted to the Network Admin for that `$network_id`. * This function allows for this to be overridden. @@ -801,7 +801,7 @@ function choose_primary_blog() { * @since 3.1.0 * * @param int $network_id The network ID to check. - * @return bool True if network can be edited, otherwise false. + * @return bool True if network can be edited, false otherwise. */ function can_edit_network( $network_id ) { if ( get_current_network_id() === (int) $network_id ) { @@ -822,7 +822,7 @@ function can_edit_network( $network_id ) { } /** - * Thickbox image paths for Network Admin. + * Prints thickbox image paths for Network Admin. * * @since 3.1.0 * @@ -981,7 +981,7 @@ function confirm_delete_users( $users ) { } /** - * Print JavaScript in the header on the Network Settings screen. + * Prints JavaScript in the header on the Network Settings screen. * * @since 4.1.0 */