Changeset 53248 for trunk/src/wp-includes/ms-functions.php

Timestamp:

04/24/2022 09:26:51 PM (2 years ago)

Author:

audrasjb

Message:

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

See #54729.

File:

• trunk/src/wp-includes/ms-functions.php (modified) (40 diffs)

trunk/src/wp-includes/ms-functions.php

@@ -30 +30 @@
 
 /**
- * Get one of a user's active blogs
+ * Gets one of a user's active blogs.
  *
  * Returns the user's primary blog, if they have one and
@@ -102 +102 @@
 
 /**
- * The number of active sites on your installation.
+ * Gets the number of active sites on the installation.
  *
  * The count is cached and updated twice daily. This is not a live count.
@@ -211 +211 @@
 
 /**
- * Remove a user from a blog.
+ * Removes a user from a blog.
  *
  * Use the {@see 'remove_user_from_blog'} action to fire an event when
@@ -302 +302 @@
 
 /**
- * Get the permalink for a post on another blog.
+ * Gets the permalink for a post on another blog.
  *
  * @since MU (3.0.0) 1.0
@@ -319 +319 @@
 
 /**
- * Get a blog's numeric ID from its URL.
+ * Gets a blog's numeric ID from its URL.
  *
  * On a subdirectory installation like example.com/blog1/,
@@ -426 +426 @@
 
 /**
- * Sanitize and validate data required for a user sign-up.
+ * Sanitizes and validates data required for a user sign-up.
  *
  * Verifies the validity and uniqueness of user names and user email addresses,
@@ -765 +765 @@
 
 /**
- * Record site signup information for future activation.
+ * Records site signup information for future activation.
  *
  * @since MU (3.0.0)
@@ -831 +831 @@
 
 /**
- * Record user signup information for future activation.
+ * Records user signup information for future activation.
  *
  * This function is used when user registration is open but
@@ -894 +894 @@
 
 /**
- * Send a confirmation request email to a user when they sign up for a new site. The new site will not become active
+ * Sends a confirmation request email to a user when they sign up for a new site. The new site will not become active
  * until the confirmation link is clicked.
  *
@@ -1032 +1032 @@
 
 /**
- * Send a confirmation request email to a user when they sign up for a new user account (without signing up for a site
+ * Sends a confirmation request email to a user when they sign up for a new user account (without signing up for a site
  * at the same time). The user account will not become active until the confirmation link is clicked.
  *
@@ -1141 +1141 @@
 
 /**
- * Activate a signup.
+ * Activates a signup.
  *
  * Hook to {@see 'wpmu_activate_user'} or {@see 'wpmu_activate_blog'} for events
@@ -1291 +1291 @@
 
 /**
- * Create a user.
+ * Creates a user.
  *
  * This function runs when a user self-registers as well as when
@@ -1330 +1330 @@
 
 /**
- * Create a site.
+ * Creates a site.
  *
  * This function runs when a user self-registers a new site as well
@@ -1806 +1806 @@
 
 /**
- * Notify a user that their account activation has been successful.
+ * Notifies a user that their account activation has been successful.
  *
  * Filter {@see 'wpmu_welcome_user_notification'} to disable or bypass.
@@ -1898 +1898 @@
 
 /**
- * Get the current network.
+ * Gets the current network.
  *
  * Returns an object containing the 'id', 'domain', 'path', and 'site_name'
@@ -1917 +1917 @@
 
 /**
- * Get a user's most recent post.
+ * Gets a user's most recent post.
  *
  * Walks through each of a user's blogs to find the post with
@@ -1969 +1969 @@
 
 /**
- * Check an array of MIME types against a list of allowed types.
+ * Checks an array of MIME types against a list of allowed types.
  *
  * WordPress ships with a set of allowed upload filetypes,
@@ -1996 +1996 @@
 
 /**
- * Update a blog's post count.
+ * Updates a blog's post count.
  *
  * WordPress MS stores a blog's post count as an option so as
@@ -2142 +2142 @@
 
 /**
- * Ensure that the current site's domain is listed in the allowed redirect host list.
+ * Ensures that the current site's domain is listed in the allowed redirect host list.
  *
  * @see wp_validate_redirect()
@@ -2159 +2159 @@
 
 /**
- * Check whether an upload is too big.
+ * Checks whether an upload is too big.
  *
  * @since MU (3.0.0)
@@ -2182 +2182 @@
 
 /**
- * Add a nonce field to the signup page.
+ * Adds a nonce field to the signup page.
  *
  * @since MU (3.0.0)
@@ -2193 +2193 @@
 
 /**
- * Process the signup nonce created in signup_nonce_fields().
+ * Processes the signup nonce created in signup_nonce_fields().
  *
  * @since MU (3.0.0)
@@ -2213 +2213 @@
 
 /**
- * Correct 404 redirects when NOBLOGREDIRECT is defined.
+ * Corrects 404 redirects when NOBLOGREDIRECT is defined.
  *
  * @since MU (3.0.0)
@@ -2242 +2242 @@
 
 /**
- * Add a new user to a blog by visiting /newbloguser/{key}/.
+ * Adds a new user to a blog by visiting /newbloguser/{key}/.
  *
  * This will only work when the user's details are saved as an option
@@ -2290 +2290 @@
 
 /**
- * Add a user to a blog based on details from maybe_add_existing_user_to_blog().
+ * Adds a user to a blog based on details from maybe_add_existing_user_to_blog().
  *
  * @since MU (3.0.0)
@@ -2352 +2352 @@
 
 /**
- * Correct From host on outgoing mail to match the site domain
+ * Corrects From host on outgoing mail to match the site domain
  *
  * @since MU (3.0.0)
@@ -2363 +2363 @@
 
 /**
- * Check to see whether a user is marked as a spammer, based on user login.
+ * Determines whether a user is marked as a spammer, based on user login.
  *
  * @since MU (3.0.0)
@@ -2384 +2384 @@
 
 /**
- * Update this blog's 'public' setting in the global blogs table.
+ * Updates this blog's 'public' setting in the global blogs table.
  *
  * Public blogs have a setting of 1, private blogs are 0.
@@ -2398 +2398 @@
 
 /**
- * Check whether users can self-register, based on Network settings.
+ * Determines whether users can self-register, based on Network settings.
  *
  * @since MU (3.0.0)
@@ -2410 +2410 @@
 
 /**
- * Ensure that the welcome message is not empty. Currently unused.
+ * Ensures that the welcome message is not empty. Currently unused.
  *
  * @since MU (3.0.0)
@@ -2442 +2442 @@
 
 /**
- * Whether to force SSL on content.
+ * Determines whether to force SSL on content.
  *
  * @since 2.8.5
@@ -2484 +2484 @@
 
 /**
- * Schedule update of the network-wide counts for the current network.
+ * Schedules update of the network-wide counts for the current network.
  *
  * @since 3.1.0
@@ -2499 +2499 @@
 
 /**
- * Update the network-wide counts for the current network.
+ * Updates the network-wide counts for the current network.
  *
  * @since 3.1.0
@@ -2512 +2512 @@
 
 /**
- * Update the count of sites for the current network.
+ * Updates the count of sites for the current network.
  *
  * If enabled through the {@see 'enable_live_network_counts'} filter, update the sites count
@@ -2543 +2543 @@
 
 /**
- * Update the network-wide users count.
+ * Updates the network-wide users count.
  *
  * If enabled through the {@see 'enable_live_network_counts'} filter, update the users count
@@ -2565 +2565 @@
 
 /**
- * Update the network-wide site count.
+ * Updates the network-wide site count.
  *
  * @since 3.7.0
@@ -2593 +2593 @@
 
 /**
- * Update the network-wide user count.
+ * Updates the network-wide user count.
  *
  * @since 3.7.0
@@ -2716 +2716 @@
 
 /**
- * Whether or not we have a large network.
+ * Determines whether or not we have a large network.
  *
  * The default criteria for a large network is either more than 10,000 users or more than 10,000 sites.
@@ -2793 +2793 @@
 
 /**
- * Send a confirmation request email when a change of network admin email address is attempted.
+ * Sends a confirmation request email when a change of network admin email address is attempted.
  *
  * The new network admin address will not become active until confirmed.
@@ -2881 +2881 @@
 
 /**
- * Send an email to the old network admin email address when the network admin email address changes.
+ * Sends an email to the old network admin email address when the network admin email address changes.
  *
  * @since 4.9.0