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

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

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

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

@@ -63 +63 @@
         }
     } else {
-        //TODO Review this call to add_user_to_blog too - to get here the user must have a role on this blog?
+        // TODO: Review this call to add_user_to_blog too - to get here the user must have a role on this blog?
         $result = add_user_to_blog( $first_blog->userblog_id, $user_id, 'subscriber' );
 
@@ -73 +73 @@
 
     if ( ( ! is_object( $primary ) ) || ( $primary->archived == 1 || $primary->spam == 1 || $primary->deleted == 1 ) ) {
-        $blogs = get_blogs_of_user( $user_id, true ); // if a user's primary blog is shut down, check their other blogs.
+        $blogs = get_blogs_of_user( $user_id, true ); // If a user's primary blog is shut down, check their other blogs.
         $ret   = false;
         if ( is_array( $blogs ) && count( $blogs ) > 0 ) {
@@ -274 +274 @@
     }
 
-    // wp_revoke_user($user_id);
+    // wp_revoke_user( $user_id );
     $user = get_userdata( $user_id );
     if ( ! $user ) {
@@ -348 +348 @@
     $id     = wp_cache_get( md5( $domain . $path ), 'blog-id-cache' );
 
-    if ( $id == -1 ) { // blog does not exist
+    if ( $id == -1 ) { // Blog does not exist.
         return 0;
     } elseif ( $id ) {
@@ -374 +374 @@
 }
 
-// Admin functions
+//
+// Admin functions.
+//
 
 /**
@@ -508 +510 @@
     }
 
-    // all numeric?
+    // All numeric?
     if ( preg_match( '/^[0-9]*$/', $user_name ) ) {
         $errors->add( 'user_name', __( 'Sorry, usernames must have letters too!' ) );
@@ -666 +668 @@
     }
 
-    // do not allow users to create a blog that conflicts with a page on the main blog.
+    // Do not allow users to create a blog that conflicts with a page on the main blog.
     if ( ! is_subdomain_install() && $wpdb->get_var( $wpdb->prepare( 'SELECT post_name FROM ' . $wpdb->get_blog_prefix( $current_network->site_id ) . "posts WHERE post_type = 'page' AND post_name = %s", $blogname ) ) ) {
         $errors->add( 'blogname', __( 'Sorry, you may not use that site name.' ) );
     }
 
-    // all numeric?
+    // All numeric?
     if ( preg_match( '/^[0-9]*$/', $blogname ) ) {
         $errors->add( 'blogname', __( 'Sorry, site names must have letters too!' ) );
@@ -713 +715 @@
 
     // Has someone already signed up for this domain?
-    $signup = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->signups WHERE domain = %s AND path = %s", $mydomain, $path ) ); // TODO: Check email too?
+    // TODO: Check email too?
+    $signup = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->signups WHERE domain = %s AND path = %s", $mydomain, $path ) );
     if ( ! empty( $signup ) ) {
         $diff = time() - mysql2date( 'U', $signup->registered );
@@ -841 +844 @@
     global $wpdb;
 
-    // Format data
+    // Format data.
     $user       = preg_replace( '/\s+/', '', sanitize_user( $user, true ) );
     $user_email = sanitize_email( $user_email );
@@ -934 +937 @@
         $activate_url = network_site_url( "wp-activate.php?key=$key" );
     } else {
-        $activate_url = "http://{$domain}{$path}wp-activate.php?key=$key"; // @todo use *_url() API
+        $activate_url = "http://{$domain}{$path}wp-activate.php?key=$key"; // @todo Use *_url() API.
     }
 
@@ -1213 +1216 @@
     // TODO: What to do if we create a user but cannot create a blog?
     if ( is_wp_error( $blog_id ) ) {
-        // If blog is taken, that means a previous attempt to activate this blog failed in between creating the blog and
-        // setting the activation flag. Let's just set the active flag and instruct the user to reset their password.
+        /*
+         * If blog is taken, that means a previous attempt to activate this blog
+         * failed in between creating the blog and setting the activation flag.
+         * Let's just set the active flag and instruct the user to reset their password.
+         */
         if ( 'blog_taken' == $blog_id->get_error_code() ) {
             $blog_id->add_data( $signup );
@@ -1789 +1795 @@
 
     // Walk through each blog and get the most recent post
-    // published by $user_id
+    // published by $user_id.
     foreach ( (array) $user_blogs as $blog ) {
         $prefix      = $wpdb->get_blog_prefix( $blog->userblog_id );
         $recent_post = $wpdb->get_row( $wpdb->prepare( "SELECT ID, post_date_gmt FROM {$prefix}posts WHERE post_author = %d AND post_type = 'post' AND post_status = 'publish' ORDER BY post_date_gmt DESC LIMIT 1", $user_id ), ARRAY_A );
 
-        // Make sure we found a post
+        // Make sure we found a post.
         if ( isset( $recent_post['ID'] ) ) {
             $post_gmt_ts = strtotime( $recent_post['post_date_gmt'] );
 
-            // If this is the first post checked or if this post is
-            // newer than the current recent post, make it the new
-            // most recent post.
+            /*
+             * If this is the first post checked
+             * or if this post is newer than the current recent post,
+             * make it the new most recent post.
+             */
             if ( ! isset( $most_recent_post['post_gmt_ts'] ) || ( $post_gmt_ts > $most_recent_post['post_gmt_ts'] ) ) {
                 $most_recent_post = array(
@@ -1815 +1823 @@
 }
 
-// Misc functions
+//
+// Misc functions.
+//
 
 /**
@@ -1921 +1931 @@
     }
 
-    // prevent a race condition
+    // Prevent a race condition.
     $recurse_start = false;
     if ( $global_terms_recurse === null ) {
@@ -2183 +2193 @@
         $blog_id = $meta['add_to_blog'];
         $role    = $meta['new_role'];
-        remove_user_from_blog( $user_id, get_network()->site_id ); // remove user from main blog.
+        remove_user_from_blog( $user_id, get_network()->site_id ); // Remove user from main blog.
 
         $result = add_user_to_blog( $blog_id, $user_id, $role );
@@ -2317 +2327 @@
 function filter_SSL( $url ) {  // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
     if ( ! is_string( $url ) ) {
-        return get_bloginfo( 'url' ); // Return home blog url with proper scheme
+        return get_bloginfo( 'url' ); // Return home blog URL with proper scheme.
     }
 
@@ -2779 +2789 @@
         'headers' => '',
     );
-    // get network name
+    // Get network name.
     $network_name = wp_specialchars_decode( get_site_option( 'site_name' ), ENT_QUOTES );