Changeset 34493

Timestamp:

09/24/2015 02:10:47 PM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Add a summary, version, and parameter and return descriptions to the DocBlock for WP_Filesystem_FTPext::get_contents().

Also reverses the return types as string is expected, false is the outlier.

See [30978].

See #30989. See #32246.

File:

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

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

@@ -94 +94 @@
 
         /**
-         * @access public
-         *
-         * @param string $file
-         * @return false|string
+         * Retrieves the file contents.
+         *
+         * @since 2.5.0
+         * @access public
+         *
+         * @param string $file Filename.
+         * @return string|false File contents on success, false if no temp file could be opened,
+         *                      or if the file couldn't be retrieved.
          */
         public function get_contents( $file ) {