Changeset 47122 for trunk/src/wp-admin/includes/class-wp-filesystem-base.php

Timestamp:

01/29/2020 12:43:23 AM (5 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/class-wp-filesystem-base.php (modified) (11 diffs)

trunk/src/wp-admin/includes/class-wp-filesystem-base.php

@@ -56 +56 @@
     public function abspath() {
         $folder = $this->find_folder( ABSPATH );
-        // Perhaps the FTP folder is rooted at the WordPress install, Check for wp-includes folder in root, Could have some false positives, but rare.
+        // Perhaps the FTP folder is rooted at the WordPress install.
+        // Check for wp-includes folder in root. Could have some false positives, but rare.
         if ( ! $folder && $this->is_dir( '/' . WPINC ) ) {
             $folder = '/';
@@ -97 +98 @@
         $theme_root = get_theme_root( $theme );
 
-        // Account for relative theme roots
+        // Account for relative theme roots.
         if ( '/themes' == $theme_root || ! is_dir( $theme_root ) ) {
             $theme_root = WP_CONTENT_DIR . $theme_root;
@@ -183 +184 @@
             );
 
-            // Direct matches ( folder = CONSTANT/ )
+            // Direct matches ( folder = CONSTANT/ ).
             foreach ( $constant_overrides as $constant => $dir ) {
                 if ( ! defined( $constant ) ) {
@@ -193 +194 @@
             }
 
-            // Prefix Matches ( folder = CONSTANT/subdir )
+            // Prefix matches ( folder = CONSTANT/subdir ),
             foreach ( $constant_overrides as $constant => $dir ) {
                 if ( ! defined( $constant ) ) {
                     continue;
                 }
-                if ( 0 === stripos( $folder, $dir ) ) { // $folder starts with $dir
+                if ( 0 === stripos( $folder, $dir ) ) { // $folder starts with $dir.
                     $potential_folder = preg_replace( '#^' . preg_quote( $dir, '#' ) . '/#i', trailingslashit( constant( $constant ) ), $folder );
                     $potential_folder = trailingslashit( $potential_folder );
@@ -209 +210 @@
             }
         } elseif ( 'direct' == $this->method ) {
-            $folder = str_replace( '\\', '/', $folder ); // Windows path sanitisation
+            $folder = str_replace( '\\', '/', $folder ); // Windows path sanitisation.
             return trailingslashit( $folder );
         }
 
-        $folder = preg_replace( '|^([a-z]{1}):|i', '', $folder ); // Strip out windows drive letter if it's there.
-        $folder = str_replace( '\\', '/', $folder ); // Windows path sanitisation
+        $folder = preg_replace( '|^([a-z]{1}):|i', '', $folder ); // Strip out Windows drive letter if it's there.
+        $folder = str_replace( '\\', '/', $folder ); // Windows path sanitisation.
 
         if ( isset( $this->cache[ $folder ] ) ) {
@@ -241 +242 @@
      * @param string $folder The folder to locate.
      * @param string $base   The folder to start searching from.
-     * @param bool   $loop   If the function has recursed, Internal use only.
+     * @param bool   $loop   If the function has recursed. Internal use only.
      * @return string|false The location of the remote path, false to cease looping.
      */
@@ -304 +305 @@
 
         // Prevent this function from looping again.
-        // No need to proceed if we've just searched in /
+        // No need to proceed if we've just searched in `/`.
         if ( $loop || '/' == $base ) {
             return false;
@@ -329 +330 @@
     public function gethchmod( $file ) {
         $perms = intval( $this->getchmod( $file ), 8 );
-        if ( ( $perms & 0xC000 ) == 0xC000 ) { // Socket
+        if ( ( $perms & 0xC000 ) == 0xC000 ) { // Socket.
             $info = 's';
-        } elseif ( ( $perms & 0xA000 ) == 0xA000 ) { // Symbolic Link
+        } elseif ( ( $perms & 0xA000 ) == 0xA000 ) { // Symbolic Link.
             $info = 'l';
-        } elseif ( ( $perms & 0x8000 ) == 0x8000 ) { // Regular
+        } elseif ( ( $perms & 0x8000 ) == 0x8000 ) { // Regular.
             $info = '-';
-        } elseif ( ( $perms & 0x6000 ) == 0x6000 ) { // Block special
+        } elseif ( ( $perms & 0x6000 ) == 0x6000 ) { // Block special.
             $info = 'b';
-        } elseif ( ( $perms & 0x4000 ) == 0x4000 ) { // Directory
+        } elseif ( ( $perms & 0x4000 ) == 0x4000 ) { // Directory.
             $info = 'd';
-        } elseif ( ( $perms & 0x2000 ) == 0x2000 ) { // Character special
+        } elseif ( ( $perms & 0x2000 ) == 0x2000 ) { // Character special.
             $info = 'c';
-        } elseif ( ( $perms & 0x1000 ) == 0x1000 ) { // FIFO pipe
+        } elseif ( ( $perms & 0x1000 ) == 0x1000 ) { // FIFO pipe.
             $info = 'p';
-        } else { // Unknown
+        } else { // Unknown.
             $info = 'u';
         }
 
-        // Owner
+        // Owner.
         $info .= ( ( $perms & 0x0100 ) ? 'r' : '-' );
         $info .= ( ( $perms & 0x0080 ) ? 'w' : '-' );
@@ -354 +355 @@
                     ( ( $perms & 0x0800 ) ? 'S' : '-' ) );
 
-        // Group
+        // Group.
         $info .= ( ( $perms & 0x0020 ) ? 'r' : '-' );
         $info .= ( ( $perms & 0x0010 ) ? 'w' : '-' );
@@ -361 +362 @@
                     ( ( $perms & 0x0400 ) ? 'S' : '-' ) );
 
-        // World
+        // World.
         $info .= ( ( $perms & 0x0004 ) ? 'r' : '-' );
         $info .= ( ( $perms & 0x0002 ) ? 'w' : '-' );
@@ -828 +829 @@
     }
 
-} // WP_Filesystem_Base
+}