Changeset 47084 for trunk/src/wp-admin/includes/deprecated.php

Timestamp:

01/18/2020 12:52:28 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve comments in some wp-admin files per the documentation standards.

Props passoniate.
Fixes #49215, #49216.

File:

• trunk/src/wp-admin/includes/deprecated.php (modified) (9 diffs)

trunk/src/wp-admin/includes/deprecated.php

@@ -234 +234 @@
                 $level_key = $wpdb->get_blog_prefix() . 'user_level';
         else
-                $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // wpmu site admins don't have user_levels
+                $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // WPMU site admins don't have user_levels.
 
         return $wpdb->get_col( $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s AND meta_value != '0'", $level_key) );
@@ -296 +296 @@
                 $level_key = $wpdb->get_blog_prefix() . 'user_level';
         else
-                $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // wpmu site admins don't have user_levels
+                $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // WPMU site admins don't have user_levels.
 
         $query = $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s", $level_key);
@@ -320 +320 @@
                 $level_key = $wpdb->get_blog_prefix() . 'user_level';
         else
-                $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // wpmu site admins don't have user_levels
+                $level_key = $wpdb->get_blog_prefix() . 'capabilities'; // WPMU site admins don't have user_levels.
 
         return $wpdb->get_col( $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = %s AND meta_value = '0'", $level_key) );
@@ -545 +545 @@
                         $this->query_where .= $wpdb->prepare(" AND $wpdb->usermeta.meta_key = '{$wpdb->prefix}capabilities' AND $wpdb->usermeta.meta_value LIKE %s", '%' . $this->role . '%');
                 } elseif ( is_multisite() ) {
-                        $level_key = $wpdb->prefix . 'capabilities'; // wpmu site admins don't have user_levels
+                        $level_key = $wpdb->prefix . 'capabilities'; // WPMU site admins don't have user_levels.
                         $this->query_from .= ", $wpdb->usermeta";
                         $this->query_where .= " AND $wpdb->users.ID = $wpdb->usermeta.user_id AND meta_key = '{$level_key}'";
@@ -565 +565 @@
 
                 if ( $this->results )
-                        $this->total_users_for_query = $wpdb->get_var("SELECT COUNT(DISTINCT($wpdb->users.ID))" . $this->query_from . $this->query_where); // no limit
+                        $this->total_users_for_query = $wpdb->get_var("SELECT COUNT(DISTINCT($wpdb->users.ID))" . $this->query_from . $this->query_where); // No limit.
                 else
                         $this->search_errors = new WP_Error('no_matching_users_found', __('No users found.'));
@@ -585 +585 @@
          */
         public function do_paging() {
-                if ( $this->total_users_for_query > $this->users_per_page ) { // have to page the results
+                if ( $this->total_users_for_query > $this->users_per_page ) { // Have to page the results.
                         $args = array();
                         if ( ! empty($this->search_term) )
@@ -1320 +1320 @@
         _deprecated_function( __FUNCTION__, '4.8.0' );
 
-        // Plugin feeds plus link to install them
+        // Plugin feeds plus link to install them.
         $popular = fetch_feed( $args['url']['popular'] );
 
@@ -1336 +1336 @@
                 $items = $feed->get_items(0, 5);
 
-                // Pick a random, non-installed plugin
+                // Pick a random, non-installed plugin.
                 while ( true ) {
-                        // Abort this foreach loop iteration if there's no plugins left of this type
+                        // Abort this foreach loop iteration if there's no plugins left of this type.
                         if ( 0 == count($items) )
                                 continue 2;
@@ -1368 +1368 @@
                 }
 
-                // Eliminate some common badly formed plugin descriptions
+                // Eliminate some common badly formed plugin descriptions.
                 while ( ( null !== $item_key = array_rand($items) ) && false !== strpos( $items[$item_key]->get_description(), 'Plugin Name:' ) )
                         unset($items[$item_key]);