From 6ac2cb05e65bd028ce29b5181fd371436abf3a4c Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 24 Sep 2015 14:10:47 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@34493 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-wp-filesystem-ftpext.php | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/wp-admin/includes/class-wp-filesystem-ftpext.php b/src/wp-admin/includes/class-wp-filesystem-ftpext.php index bfa19ac0d3..541079d7b3 100644 --- a/src/wp-admin/includes/class-wp-filesystem-ftpext.php +++ b/src/wp-admin/includes/class-wp-filesystem-ftpext.php @@ -93,10 +93,14 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base { } /** + * Retrieves the file contents. + * + * @since 2.5.0 * @access public * - * @param string $file - * @return false|string + * @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 ) { $tempfile = wp_tempnam($file);