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

Timestamp:

01/29/2020 12:33:45 AM (5 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.php (modified) (16 diffs)

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

@@ -332 +332 @@
         }
 
-        $plugin_data = get_plugin_data( "$plugin_root/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
+        // Do not apply markup/translate as it will be cached.
+        $plugin_data = get_plugin_data( "$plugin_root/$plugin_file", false, false );
 
         if ( empty( $plugin_data['Name'] ) ) {
@@ -358 +359 @@
  */
 function get_mu_plugins() {
-    $wp_plugins = array();
-    // Files in wp-content/mu-plugins directory.
+    $wp_plugins   = array();
     $plugin_files = array();
 
@@ -365 +365 @@
         return $wp_plugins;
     }
+
+    // Files in wp-content/mu-plugins directory.
     $plugins_dir = @opendir( WPMU_PLUGIN_DIR );
     if ( $plugins_dir ) {
@@ -387 +389 @@
         }
 
-        $plugin_data = get_plugin_data( WPMU_PLUGIN_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
+        // Do not apply markup/translate as it will be cached.
+        $plugin_data = get_plugin_data( WPMU_PLUGIN_DIR . "/$plugin_file", false, false );
 
         if ( empty( $plugin_data['Name'] ) ) {
@@ -396 +399 @@
     }
 
-    if ( isset( $wp_plugins['index.php'] ) && filesize( WPMU_PLUGIN_DIR . '/index.php' ) <= 30 ) { // silence is golden
+    if ( isset( $wp_plugins['index.php'] ) && filesize( WPMU_PLUGIN_DIR . '/index.php' ) <= 30 ) {
+        // Silence is golden.
         unset( $wp_plugins['index.php'] );
     }
@@ -432 +436 @@
     $_dropins = _get_dropins();
 
-    // These exist in the wp-content directory.
+    // Files in wp-content directory.
     $plugins_dir = @opendir( WP_CONTENT_DIR );
     if ( $plugins_dir ) {
@@ -454 +458 @@
             continue;
         }
-        $plugin_data = get_plugin_data( WP_CONTENT_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
+
+        // Do not apply markup/translate as it will be cached.
+        $plugin_data = get_plugin_data( WP_CONTENT_DIR . "/$plugin_file", false, false );
+
         if ( empty( $plugin_data['Name'] ) ) {
             $plugin_data['Name'] = $plugin_file;
         }
+
         $dropins[ $plugin_file ] = $plugin_data;
     }
@@ -478 +486 @@
 function _get_dropins() {
     $dropins = array(
-        'advanced-cache.php'      => array( __( 'Advanced caching plugin.' ), 'WP_CACHE' ), // WP_CACHE
-        'db.php'                  => array( __( 'Custom database class.' ), true ), // auto on load
-        'db-error.php'            => array( __( 'Custom database error message.' ), true ), // auto on error
-        'install.php'             => array( __( 'Custom installation script.' ), true ), // auto on installation
-        'maintenance.php'         => array( __( 'Custom maintenance message.' ), true ), // auto on maintenance
-        'object-cache.php'        => array( __( 'External object cache.' ), true ), // auto on load
-        'php-error.php'           => array( __( 'Custom PHP error message.' ), true ), // auto on error
-        'fatal-error-handler.php' => array( __( 'Custom PHP fatal error handler.' ), true ), // auto on error
+        'advanced-cache.php'      => array( __( 'Advanced caching plugin.' ), 'WP_CACHE' ),  // WP_CACHE
+        'db.php'                  => array( __( 'Custom database class.' ), true ),          // Auto on load.
+        'db-error.php'            => array( __( 'Custom database error message.' ), true ),  // Auto on error.
+        'install.php'             => array( __( 'Custom installation script.' ), true ),     // Auto on installation.
+        'maintenance.php'         => array( __( 'Custom maintenance message.' ), true ),     // Auto on maintenance.
+        'object-cache.php'        => array( __( 'External object cache.' ), true ),          // Auto on load.
+        'php-error.php'           => array( __( 'Custom PHP error message.' ), true ),       // Auto on error.
+        'fatal-error-handler.php' => array( __( 'Custom PHP fatal error handler.' ), true ), // Auto on error.
     );
 
     if ( is_multisite() ) {
         $dropins['sunrise.php']        = array( __( 'Executed before Multisite is loaded.' ), 'SUNRISE' ); // SUNRISE
-        $dropins['blog-deleted.php']   = array( __( 'Custom site deleted message.' ), true ); // auto on deleted blog
-        $dropins['blog-inactive.php']  = array( __( 'Custom site inactive message.' ), true ); // auto on inactive blog
-        $dropins['blog-suspended.php'] = array( __( 'Custom site suspended message.' ), true ); // auto on archived or spammed blog
+        $dropins['blog-deleted.php']   = array( __( 'Custom site deleted message.' ), true );   // Auto on deleted blog.
+        $dropins['blog-inactive.php']  = array( __( 'Custom site inactive message.' ), true );  // Auto on inactive blog.
+        $dropins['blog-suspended.php'] = array( __( 'Custom site suspended message.' ), true ); // Auto on archived or spammed blog.
     }
 
@@ -639 +647 @@
     if ( ( $network_wide && ! isset( $current[ $plugin ] ) ) || ( ! $network_wide && ! in_array( $plugin, $current ) ) ) {
         if ( ! empty( $redirect ) ) {
-            wp_redirect( add_query_arg( '_error_nonce', wp_create_nonce( 'plugin-activation-error_' . $plugin ), $redirect ) ); // we'll override this later if the plugin can be included without fatal error
+            // We'll override this later if the plugin can be included without fatal error.
+            wp_redirect( add_query_arg( '_error_nonce', wp_create_nonce( 'plugin-activation-error_' . $plugin ), $redirect ) );
         }
 
@@ -909 +918 @@
     if ( ! WP_Filesystem( $credentials ) ) {
         ob_start();
-        request_filesystem_credentials( $url, '', true ); // Failed to connect, Error and request again.
+        // Failed to connect. Error and request again.
+        request_filesystem_credentials( $url, '', true );
         $data = ob_get_clean();
 
@@ -959 +969 @@
 
         // If plugin is in its own directory, recursively delete the directory.
-        if ( strpos( $plugin_file, '/' ) && $this_plugin_dir != $plugins_dir ) { //base check on if plugin includes directory separator AND that it's not the root plugin folder
+        // Base check on if plugin includes directory separator AND that it's not the root plugin folder.
+        if ( strpos( $plugin_file, '/' ) && $this_plugin_dir != $plugins_dir ) {
             $deleted = $wp_filesystem->delete( $this_plugin_dir, true );
         } else {
@@ -1238 +1249 @@
 
 //
-// Menu
+// Menu.
 //
 
@@ -1307 +1318 @@
     $_registered_pages[ $hookname ] = true;
 
-    // No parent as top level
+    // No parent as top level.
     $_parent_pages[ $menu_slug ] = false;
 
@@ -1413 +1424 @@
         }
     }
-    // Sort the parent array
+    // Sort the parent array.
     ksort( $submenu[ $parent_slug ] );
 
@@ -1794 +1805 @@
 
 //
-// Pluggable Menu Support -- Private
+// Pluggable Menu Support -- Private.
 //
 /**
@@ -1933 +1944 @@
                 }
 
-                if ( $submenu_array[2] != $pagenow || isset( $_GET['page'] ) ) { // not the current page
+                if ( $submenu_array[2] != $pagenow || isset( $_GET['page'] ) ) { // Not the current page.
                     continue;
                 }