Changeset 47122 for trunk/src/wp-admin/includes/theme.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-admin/includes/theme.php (modified) (8 diffs)

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

@@ -46 +46 @@
         if ( ! WP_Filesystem( $credentials ) ) {
                 ob_start();
-                request_filesystem_credentials( $redirect, '', true ); // Failed to connect, Error and request again.
+                // Failed to connect. Error and request again.
+                request_filesystem_credentials( $redirect, '', true );
                 $data = ob_get_clean();
 
@@ -195 +196 @@
                         ),
                         $update['url']
-                ); //Theme browser inside WP? replace this, Also, theme preview JS will override this on the available list.
+                ); // Theme browser inside WP? Replace this. Also, theme preview JS will override this on the available list.
                 $update_url  = wp_nonce_url( admin_url( 'update.php?action=upgrade-theme&theme=' . urlencode( $stylesheet ) ), 'upgrade-theme_' . $stylesheet );
 
@@ -261 +262 @@
  */
 function get_theme_feature_list( $api = true ) {
-        // Hard-coded list is used if api not accessible.
+        // Hard-coded list is used if API is not accessible.
         $features = array(
 
@@ -332 +333 @@
         );
 
-        // Loop over the wporg canonical list and apply translations
+        // Loop over the wp.org canonical list and apply translations.
         $wporg_features = array();
         foreach ( (array) $feature_list as $feature_category => $feature_items ) {
@@ -434 +435 @@
  */
 function themes_api( $action, $args = array() ) {
-        // include an unmodified $wp_version
+        // Include an unmodified $wp_version.
         include( ABSPATH . WPINC . '/version.php' );
 
@@ -452 +453 @@
 
         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
         }
 
@@ -656 +657 @@
                         'id'           => $slug,
                         'name'         => $theme->display( 'Name' ),
-                        'screenshot'   => array( $theme->get_screenshot() ), // @todo multiple
+                        'screenshot'   => array( $theme->get_screenshot() ), // @todo Multiple screenshots.
                         'description'  => $theme->display( 'Description' ),
                         'author'       => $theme->display( 'Author', false, true ),
@@ -675 +676 @@
         }
 
-        // Remove 'delete' action if theme has an active child
+        // Remove 'delete' action if theme has an active child.
         if ( ! empty( $parents ) && array_key_exists( $current_theme, $parents ) ) {
                 unset( $prepared_themes[ $parents[ $current_theme ] ]['actions']['delete'] );