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.

Built from https://develop.svn.wordpress.org/trunk@34495


git-svn-id: http://core.svn.wordpress.org/trunk@34459 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-09-24 14:22:24 +00:00
parent b45178379b
commit 0fc9bed46e
2 changed files with 8 additions and 4 deletions

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

View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.4-alpha-34494';
$wp_version = '4.4-alpha-34495';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.