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
This commit is contained in:
Drew Jaynes 2015-09-24 14:21:50 +00:00
parent 30554cccab
commit 02e1102a5b

View File

@ -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) )