Changeset 60261

Timestamp:

05/28/2025 10:47:56 AM (3 weeks ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for WP_Filesystem_FTPext::parselisting().

Includes:

• Adding a summary for the method.
• Documenting the $line parameter.
• Documenting the case when an empty string is returned.

Follow-up to [7126], [30678], [55714].

Props opurockey, abcd95, SergeyBiryukov.
Fixes #63491.

File:

• trunk/src/wp-admin/includes/class-wp-filesystem-ftpext.php (modified) (1 diff)

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

@@ -602 +602 @@
 
     /**
-     * @param string $line
-     * @return array {
-     *     Array of file information.
+     * Parses an individual entry from the FTP LIST command output.
+     *
+     * @param string $line A line from the directory listing.
+     * @return array|string {
+     *     Array of file information. Empty string if the line could not be parsed.
      *
      *     @type string       $name        Name of the file or directory.