Changeset 47119 for trunk/src/wp-admin/includes/ms.php

Timestamp:

01/29/2020 12:33:45 AM (7 years ago)

Author:

SergeyBiryukov

Message:

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

Follow-up to [47084].

Props passoniate, apedog.
Fixes #49223, #49227.

File:

• trunk/src/wp-admin/includes/ms.php (modified) (10 diffs)

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

@@ -21 +21 @@
         }
 
-        if ( $file['error'] != '0' ) { // there's already an error
+        if ( $file['error'] != '0' ) { // There's already an error.
                 return $file;
         }
@@ -130 +130 @@
  * @since 3.0.0
  *
- * @todo Merge with wp_delete_user() ?
+ * @todo Merge with wp_delete_user()?
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -178 +178 @@
                         }
 
-                        // Clean links
+                        // Clean links.
                         $link_ids = $wpdb->get_col( $wpdb->prepare( "SELECT link_id FROM $wpdb->links WHERE link_owner = %d", $id ) );
 
@@ -221 +221 @@
         $space_allowed = get_space_allowed();
         if ( ! is_numeric( $space_allowed ) ) {
-                $space_allowed = 10; // Default space allowed is 10 MB
+                $space_allowed = 10; // Default space allowed is 10 MB.
         }
         $space_used = get_space_used();
@@ -645 +645 @@
                 $code_lang = basename( $val, '.mo' );
 
-                if ( $code_lang == 'en_US' ) { // American English
+                if ( $code_lang == 'en_US' ) { // American English.
                         $flag          = true;
                         $ae            = __( 'American English' );
                         $output[ $ae ] = '<option value="' . esc_attr( $code_lang ) . '"' . selected( $current, $code_lang, false ) . '> ' . $ae . '</option>';
-                } elseif ( $code_lang == 'en_GB' ) { // British English
+                } elseif ( $code_lang == 'en_GB' ) { // British English.
                         $flag          = true;
                         $be            = __( 'British English' );
@@ -659 +659 @@
         }
 
-        if ( $flag === false ) { // WordPress english
+        if ( $flag === false ) { // WordPress English.
                 $output[] = '<option value=""' . selected( $current, '', false ) . '>' . __( 'English' ) . '</option>';
         }
 
-        // Order by name
+        // Order by name.
         uksort( $output, 'strnatcasecmp' );
 
@@ -1068 +1068 @@
         );
 
-        // Parse arguments
+        // Parse arguments.
         $parsed_args = wp_parse_args(
                 $args,
@@ -1078 +1078 @@
         );
 
-        // Setup the links array
+        // Setup the links array.
         $screen_links = array();
 
-        // Loop through tabs
+        // Loop through tabs.
         foreach ( $parsed_args['links'] as $link_id => $link ) {
 
-                // Skip link if user can't access
+                // Skip link if user can't access.
                 if ( ! current_user_can( $link['cap'], $parsed_args['blog_id'] ) ) {
                         continue;
                 }
 
-                // Link classes
+                // Link classes.
                 $classes = array( 'nav-tab' );
 
@@ -1095 +1095 @@
                 $aria_current = '';
 
-                // Selected is set by the parent OR assumed by the $pagenow global
+                // Selected is set by the parent OR assumed by the $pagenow global.
                 if ( $parsed_args['selected'] === $link_id || $link['url'] === $GLOBALS['pagenow'] ) {
                         $classes[]    = 'nav-tab-active';
@@ -1101 +1101 @@
                 }
 
-                // Escape each class
+                // Escape each class.
                 $esc_classes = implode( ' ', $classes );
 
-                // Get the URL for this link
+                // Get the URL for this link.
                 $url = add_query_arg( array( 'id' => $parsed_args['blog_id'] ), network_admin_url( $link['url'] ) );
 
-                // Add link to nav links
+                // Add link to nav links.
                 $screen_links[ $link_id ] = '<a href="' . esc_url( $url ) . '" id="' . esc_attr( $link_id ) . '" class="' . $esc_classes . '"' . $aria_current . '>' . esc_html( $link['label'] ) . '</a>';
         }