Make WordPress Core

Changeset 53248


Ignore:
Timestamp:
04/24/2022 09:26:51 PM (14 months ago)
Author:
audrasjb
Message:

Docs: Use third-person singular verbs for function descriptions in Multisite WordPress API, as per docs standards.

See #54729.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/ms-functions.php

    r53131 r53248  
    3030
    3131/**
    32  * Get one of a user's active blogs
     32 * Gets one of a user's active blogs.
    3333 *
    3434 * Returns the user's primary blog, if they have one and
     
    102102
    103103/**
    104  * The number of active sites on your installation.
     104 * Gets the number of active sites on the installation.
    105105 *
    106106 * The count is cached and updated twice daily. This is not a live count.
     
    211211
    212212/**
    213  * Remove a user from a blog.
     213 * Removes a user from a blog.
    214214 *
    215215 * Use the {@see 'remove_user_from_blog'} action to fire an event when
     
    302302
    303303/**
    304  * Get the permalink for a post on another blog.
     304 * Gets the permalink for a post on another blog.
    305305 *
    306306 * @since MU (3.0.0) 1.0
     
    319319
    320320/**
    321  * Get a blog's numeric ID from its URL.
     321 * Gets a blog's numeric ID from its URL.
    322322 *
    323323 * On a subdirectory installation like example.com/blog1/,
     
    426426
    427427/**
    428  * Sanitize and validate data required for a user sign-up.
     428 * Sanitizes and validates data required for a user sign-up.
    429429 *
    430430 * Verifies the validity and uniqueness of user names and user email addresses,
     
    765765
    766766/**
    767  * Record site signup information for future activation.
     767 * Records site signup information for future activation.
    768768 *
    769769 * @since MU (3.0.0)
     
    831831
    832832/**
    833  * Record user signup information for future activation.
     833 * Records user signup information for future activation.
    834834 *
    835835 * This function is used when user registration is open but
     
    894894
    895895/**
    896  * Send a confirmation request email to a user when they sign up for a new site. The new site will not become active
     896 * Sends a confirmation request email to a user when they sign up for a new site. The new site will not become active
    897897 * until the confirmation link is clicked.
    898898 *
     
    10321032
    10331033/**
    1034  * Send a confirmation request email to a user when they sign up for a new user account (without signing up for a site
     1034 * Sends a confirmation request email to a user when they sign up for a new user account (without signing up for a site
    10351035 * at the same time). The user account will not become active until the confirmation link is clicked.
    10361036 *
     
    11411141
    11421142/**
    1143  * Activate a signup.
     1143 * Activates a signup.
    11441144 *
    11451145 * Hook to {@see 'wpmu_activate_user'} or {@see 'wpmu_activate_blog'} for events
     
    12911291
    12921292/**
    1293  * Create a user.
     1293 * Creates a user.
    12941294 *
    12951295 * This function runs when a user self-registers as well as when
     
    13301330
    13311331/**
    1332  * Create a site.
     1332 * Creates a site.
    13331333 *
    13341334 * This function runs when a user self-registers a new site as well
     
    18061806
    18071807/**
    1808  * Notify a user that their account activation has been successful.
     1808 * Notifies a user that their account activation has been successful.
    18091809 *
    18101810 * Filter {@see 'wpmu_welcome_user_notification'} to disable or bypass.
     
    18981898
    18991899/**
    1900  * Get the current network.
     1900 * Gets the current network.
    19011901 *
    19021902 * Returns an object containing the 'id', 'domain', 'path', and 'site_name'
     
    19171917
    19181918/**
    1919  * Get a user's most recent post.
     1919 * Gets a user's most recent post.
    19201920 *
    19211921 * Walks through each of a user's blogs to find the post with
     
    19691969
    19701970/**
    1971  * Check an array of MIME types against a list of allowed types.
     1971 * Checks an array of MIME types against a list of allowed types.
    19721972 *
    19731973 * WordPress ships with a set of allowed upload filetypes,
     
    19961996
    19971997/**
    1998  * Update a blog's post count.
     1998 * Updates a blog's post count.
    19991999 *
    20002000 * WordPress MS stores a blog's post count as an option so as
     
    21422142
    21432143/**
    2144  * Ensure that the current site's domain is listed in the allowed redirect host list.
     2144 * Ensures that the current site's domain is listed in the allowed redirect host list.
    21452145 *
    21462146 * @see wp_validate_redirect()
     
    21592159
    21602160/**
    2161  * Check whether an upload is too big.
     2161 * Checks whether an upload is too big.
    21622162 *
    21632163 * @since MU (3.0.0)
     
    21822182
    21832183/**
    2184  * Add a nonce field to the signup page.
     2184 * Adds a nonce field to the signup page.
    21852185 *
    21862186 * @since MU (3.0.0)
     
    21932193
    21942194/**
    2195  * Process the signup nonce created in signup_nonce_fields().
     2195 * Processes the signup nonce created in signup_nonce_fields().
    21962196 *
    21972197 * @since MU (3.0.0)
     
    22132213
    22142214/**
    2215  * Correct 404 redirects when NOBLOGREDIRECT is defined.
     2215 * Corrects 404 redirects when NOBLOGREDIRECT is defined.
    22162216 *
    22172217 * @since MU (3.0.0)
     
    22422242
    22432243/**
    2244  * Add a new user to a blog by visiting /newbloguser/{key}/.
     2244 * Adds a new user to a blog by visiting /newbloguser/{key}/.
    22452245 *
    22462246 * This will only work when the user's details are saved as an option
     
    22902290
    22912291/**
    2292  * Add a user to a blog based on details from maybe_add_existing_user_to_blog().
     2292 * Adds a user to a blog based on details from maybe_add_existing_user_to_blog().
    22932293 *
    22942294 * @since MU (3.0.0)
     
    23522352
    23532353/**
    2354  * Correct From host on outgoing mail to match the site domain
     2354 * Corrects From host on outgoing mail to match the site domain
    23552355 *
    23562356 * @since MU (3.0.0)
     
    23632363
    23642364/**
    2365  * Check to see whether a user is marked as a spammer, based on user login.
     2365 * Determines whether a user is marked as a spammer, based on user login.
    23662366 *
    23672367 * @since MU (3.0.0)
     
    23842384
    23852385/**
    2386  * Update this blog's 'public' setting in the global blogs table.
     2386 * Updates this blog's 'public' setting in the global blogs table.
    23872387 *
    23882388 * Public blogs have a setting of 1, private blogs are 0.
     
    23982398
    23992399/**
    2400  * Check whether users can self-register, based on Network settings.
     2400 * Determines whether users can self-register, based on Network settings.
    24012401 *
    24022402 * @since MU (3.0.0)
     
    24102410
    24112411/**
    2412  * Ensure that the welcome message is not empty. Currently unused.
     2412 * Ensures that the welcome message is not empty. Currently unused.
    24132413 *
    24142414 * @since MU (3.0.0)
     
    24422442
    24432443/**
    2444  * Whether to force SSL on content.
     2444 * Determines whether to force SSL on content.
    24452445 *
    24462446 * @since 2.8.5
     
    24842484
    24852485/**
    2486  * Schedule update of the network-wide counts for the current network.
     2486 * Schedules update of the network-wide counts for the current network.
    24872487 *
    24882488 * @since 3.1.0
     
    24992499
    25002500/**
    2501  * Update the network-wide counts for the current network.
     2501 * Updates the network-wide counts for the current network.
    25022502 *
    25032503 * @since 3.1.0
     
    25122512
    25132513/**
    2514  * Update the count of sites for the current network.
     2514 * Updates the count of sites for the current network.
    25152515 *
    25162516 * If enabled through the {@see 'enable_live_network_counts'} filter, update the sites count
     
    25432543
    25442544/**
    2545  * Update the network-wide users count.
     2545 * Updates the network-wide users count.
    25462546 *
    25472547 * If enabled through the {@see 'enable_live_network_counts'} filter, update the users count
     
    25652565
    25662566/**
    2567  * Update the network-wide site count.
     2567 * Updates the network-wide site count.
    25682568 *
    25692569 * @since 3.7.0
     
    25932593
    25942594/**
    2595  * Update the network-wide user count.
     2595 * Updates the network-wide user count.
    25962596 *
    25972597 * @since 3.7.0
     
    27162716
    27172717/**
    2718  * Whether or not we have a large network.
     2718 * Determines whether or not we have a large network.
    27192719 *
    27202720 * The default criteria for a large network is either more than 10,000 users or more than 10,000 sites.
     
    27932793
    27942794/**
    2795  * Send a confirmation request email when a change of network admin email address is attempted.
     2795 * Sends a confirmation request email when a change of network admin email address is attempted.
    27962796 *
    27972797 * The new network admin address will not become active until confirmed.
     
    28812881
    28822882/**
    2883  * Send an email to the old network admin email address when the network admin email address changes.
     2883 * Sends an email to the old network admin email address when the network admin email address changes.
    28842884 *
    28852885 * @since 4.9.0
Note: See TracChangeset for help on using the changeset viewer.