Changeset 55075

Timestamp:

01/15/2023 05:50:13 PM (23 months ago)

Author:

audrasjb

Message:

Docs: Various docblock fixes in Multisite WordPress API related functions.

Follow-up to [55074].

See #56792.

File:

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

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

@@ -146 +146 @@
  * @param int    $blog_id ID of the blog the user is being added to.
  * @param int    $user_id ID of the user being added.
- * @param string $role    The role you want the user to have.
+ * @param string $role    User role.
  * @return true|WP_Error True on success or a WP_Error object if the user doesn't exist
  *                       or could not be added.
@@ -308 +308 @@
  * @param int $blog_id ID of the source blog.
  * @param int $post_id ID of the desired post.
- * @return string The post's permalink
+ * @return string The post's permalink.
  */
 function get_blog_permalink( $blog_id, $post_id ) {
@@ -330 +330 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param string $domain
+ * @param string $domain Website domain.
  * @param string $path   Optional. Not required for subdomain installations.
- * @return int 0 if no blog found, otherwise the ID of the matching blog
+ * @return int 0 if no blog found, otherwise the ID of the matching blog.
  */
 function get_blog_id_from_url( $domain, $path = '/' ) {
@@ -914 +914 @@
  * @param string $user_login The user's login name.
  * @param string $user_email The user's email address.
- * @param string $key        The activation key created in wpmu_signup_blog()
+ * @param string $key        The activation key created in wpmu_signup_blog().
  * @param array  $meta       Optional. Signup meta data. By default, contains the requested privacy setting and lang_id.
  * @return bool
@@ -1153 +1153 @@
  *
  * @param string $key The activation key provided to the user.
- * @return array|WP_Error An array containing information about the activated user and/or blog
+ * @return array|WP_Error An array containing information about the activated user and/or blog.
  */
 function wpmu_activate_signup( $key ) {
@@ -1305 +1305 @@
  * @param string $password  The new user's password.
  * @param string $email     The new user's email address.
- * @return int|false Returns false on failure, or int $user_id on success
+ * @return int|false Returns false on failure, or int $user_id on success.
  */
 function wpmu_create_user( $user_name, $password, $email ) {
@@ -1909 +1909 @@
  * @since MU (3.0.0)
  *
- * @global WP_Network $current_site
- *
- * @return WP_Network
+ * @global WP_Network $current_site The current network.
+ *
+ * @return WP_Network The current network.
  */
 function get_current_site() {
@@ -1928 +1928 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param int $user_id
- * @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts
+ * @param int $user_id User ID.
+ * @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts.
  */
 function get_most_recent_post_of_user( $user_id ) {
@@ -2076 +2076 @@
  * @blessed
  *
- * @param array $upload
+ * @param array $upload An array of information about the newly-uploaded file.
  * @return string|array If the upload is under the size limit, $upload is returned. Otherwise returns an error message.
  */
@@ -2263 +2263 @@
 
 /**
- * Corrects 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)
@@ -2301 +2301 @@
  * @since MU (3.0.0)
  *
- * @param int $old_value
- * @param int $value     The new public value
+ * @param int $old_value The old public value.
+ * @param int $value     The new public value.
  */
 function update_blog_public( $old_value, $value ) {
@@ -2379 +2379 @@
  * @since 2.8.5
  *
- * @param string $url URL
- * @return string URL with https as the scheme
+ * @param string $url URL.
+ * @return string URL with https as the scheme.
  */
 function filter_SSL( $url ) {  // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
@@ -2546 +2546 @@
  * @since MU (3.0.0)
  *
- * @return int Quota in megabytes
+ * @return int Quota in megabytes.
  */
 function get_space_allowed() {
@@ -2574 +2574 @@
  * @since 3.0.0
  *
- * @return int of upload space available in bytes
+ * @return int of upload space available in bytes.
  */
 function get_upload_space_available() {