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

SergeyBiryukov · SergeyBiryukov · commit 5c519f8f7c8c · 2025-05-28T10:47:56.000Z
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. git-svn-id: https://develop.svn.wordpress.org/trunk@60261 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-admin/includes/class-wp-filesystem-ftpext.php b/src/wp-admin/includes/class-wp-filesystem-ftpext.php
@@ -601,9 +601,11 @@ public function rmdir( $path, $recursive = false ) {
 	}
 
 	/**
-	 * @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.
 	 *     @type string       $perms       *nix representation of permissions.

Original file line number	Diff line number	Diff line change
`@@ -601,9 +601,11 @@ public function rmdir( $path, $recursive = false ) {`
`601`	`601`	`}`
`602`	`602`
`603`	`603`	`/**`
`604`		`- * @param string $line`
`605`		`- * @return array {`
`606`		`- * Array of file information.`
	`604`	`+ * Parses an individual entry from the FTP LIST command output.`
	`605`	`+ *`
	`606`	`+ * @param string $line A line from the directory listing.`
	`607`	`+ * @return array\|string {`
	`608`	`+ * Array of file information. Empty string if the line could not be parsed.`
`607`	`609`	`*`
`608`	`610`	`* @type string $name Name of the file or directory.`
`609`	`611`	`* @type string $perms *nix representation of permissions.`