Changeset 47119 for trunk/src/wp-admin/includes/plugin-install.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/plugin-install.php (modified) (9 diffs)

trunk/src/wp-admin/includes/plugin-install.php

@@ -101 +101 @@
  */
 function plugins_api( $action, $args = array() ) {
-        // include an unmodified $wp_version
+        // Include an unmodified $wp_version.
         include( ABSPATH . WPINC . '/version.php' );
 
@@ -119 +119 @@
 
         if ( ! isset( $args->wp_version ) ) {
-                $args->wp_version = substr( $wp_version, 0, 3 ); // X.y
+                $args->wp_version = substr( $wp_version, 0, 3 ); // x.y
         }
 
@@ -286 +286 @@
                 echo $api_tags->get_error_message();
         } else {
-                //Set up the tags in a way which can be interpreted by wp_generate_tag_cloud()
+                // Set up the tags in a way which can be interpreted by wp_generate_tag_cloud().
                 $tags = array();
                 foreach ( (array) $api_tags as $tag ) {
@@ -438 +438 @@
         }
 
-        // Default to a "new" plugin
+        // Default to a "new" plugin.
         $status      = 'install';
         $url         = false;
@@ -471 +471 @@
                                 }
                         } else {
-                                $key         = array_keys( $installed_plugin );
-                                $key         = reset( $key ); //Use the first plugin regardless of the name, Could have issues for multiple-plugins in one directory if they share different version numbers
+                                $key = array_keys( $installed_plugin );
+                                // Use the first plugin regardless of the name.
+                                // Could have issues for multiple plugins in one directory if they share different version numbers.
+                                $key = reset( $key );
+
                                 $update_file = $api->slug . '/' . $key;
                                 if ( version_compare( $api->version, $installed_plugin[ $key ]['Version'], '=' ) ) {
@@ -480 +483 @@
                                         $version = $installed_plugin[ $key ]['Version'];
                                 } else {
-                                        //If the above update check failed, Then that probably means that the update checker has out-of-date information, force a refresh
+                                        // If the above update check failed, then that probably means that the update checker has out-of-date information, force a refresh.
                                         if ( ! $loop ) {
                                                 delete_site_transient( 'update_plugins' );
@@ -489 +492 @@
                         }
                 } else {
-                        // "install" & no directory with that slug
+                        // "install" & no directory with that slug.
                         if ( current_user_can( 'install_plugins' ) ) {
                                 $url = wp_nonce_url( self_admin_url( 'update.php?action=install-plugin&plugin=' . $api->slug ), 'install-plugin_' . $api->slug );
@@ -571 +574 @@
         );
 
-        // Sanitize HTML
+        // Sanitize HTML.
         foreach ( (array) $api->sections as $section_name => $content ) {
                 $api->sections[ $section_name ] = wp_kses( $content, $plugins_allowedtags );
@@ -584 +587 @@
         $_tab = esc_attr( $tab );
 
-        $section = isset( $_REQUEST['section'] ) ? wp_unslash( $_REQUEST['section'] ) : 'description'; // Default to the Description tab, Do not translate, API returns English.
+        // Default to the Description tab, Do not translate, API returns English.
+        $section = isset( $_REQUEST['section'] ) ? wp_unslash( $_REQUEST['section'] ) : 'description';
         if ( empty( $section ) || ! isset( $api->sections[ $section ] ) ) {
                 $section_titles = array_keys( (array) $api->sections );