From 02e1102a5b585441aeaa6198ddf3160d04ee56f7 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 24 Sep 2015 14:21:50 +0000 Subject: [PATCH] Docs: Add a summary, version, and parameter and return descriptions to the DocBlock for `WP_Filesystem_ftpsockets::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@34495 602fd350-edb4-49c9-b593-d223f7449a82 --- .../includes/class-wp-filesystem-ftpsockets.php | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/wp-admin/includes/class-wp-filesystem-ftpsockets.php b/src/wp-admin/includes/class-wp-filesystem-ftpsockets.php index 68f8227562..a7a9002c6d 100644 --- a/src/wp-admin/includes/class-wp-filesystem-ftpsockets.php +++ b/src/wp-admin/includes/class-wp-filesystem-ftpsockets.php @@ -91,10 +91,14 @@ class WP_Filesystem_ftpsockets 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 doesn't exist. */ public function get_contents( $file ) { if ( ! $this->exists($file) )