WordPress.org
Get WordPress

Make WordPress Core

Changeset 54833


Ignore:
Timestamp:
11/13/2022 11:17:47 PM (2 years ago)
Author:
audrasjb
Message:

Docs: Various docblock fixes in Multisite administration functions.

See #56792.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/ms.php

    r54832 r54833  
    99
    1010/**
    11  * Determine if uploaded file exceeds space quota.
     11 * Determines whether uploaded file exceeds space quota.
    1212 *
    1313 * @since 3.0.0
    … …  
    5454
    5555/**
    56  * Delete a site.
     56 * Deletes a site.
    5757 *
    5858 * @since 3.0.0
    … …  
    131131
    132132/**
    133  * Delete a user from the network and remove from all sites.
     133 * Deletes a user from the network and remove from all sites.
    134134 *
    135135 * @since 3.0.0
    … …  
    140140 *
    141141 * @param int $id The user ID.
    142  * @return bool True if the user was deleted, otherwise false.
     142 * @return bool True if the user was deleted, false otherwise.
    143143 */
    144144function wpmu_delete_user( $id ) {
    … …  
    214214
    215215/**
    216  * Check whether a site has used its allotted upload space.
     216 * Checks whether a site has used its allotted upload space.
    217217 *
    218218 * @since MU (3.0.0)
    … …  
    270270
    271271/**
    272  * Get the remaining upload space for this site.
     272 * Gets the remaining upload space for this site.
    273273 *
    274274 * @since MU (3.0.0)
    275275 *
    276  * @param int $size Current max size in bytes
    277  * @return int Max size in bytes
     276 * @param int $size Current max size in bytes.
     277 * @return int Max size in bytes.
    278278 */
    279279function fix_import_form_size( $size ) {
    … …  
    794794
    795795/**
    796  * Whether or not we can edit this network from this page.
     796 * Determines whether or not this network from this page can be edited.
    797797 *
    798798 * By default editing of network is restricted to the Network Admin for that `$network_id`.
    … …  
    802802 *
    803803 * @param int $network_id The network ID to check.
    804  * @return bool True if network can be edited, otherwise false.
     804 * @return bool True if network can be edited, false otherwise.
    805805 */
    806806function can_edit_network( $network_id ) {
    … …  
    823823
    824824/**
    825  * Thickbox image paths for Network Admin.
     825 * Prints thickbox image paths for Network Admin.
    826826 *
    827827 * @since 3.1.0
    … …  
    982982
    983983/**
    984  * Print JavaScript in the header on the Network Settings screen.
     984 * Prints JavaScript in the header on the Network Settings screen.
    985985 *
    986986 * @since 4.1.0
Note: See TracChangeset for help on using the changeset viewer.