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.

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


git-svn-id: http://core.svn.wordpress.org/trunk@34457 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-09-24 14:11:26 +00:00
parent 175d476b0e
commit fbb6ef1922
2 changed files with 7 additions and 3 deletions

View File

@ -93,10 +93,14 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* Retrieves the file contents.
*
* @since 2.5.0
* @access public * @access public
* *
* @param string $file * @param string $file Filename.
* @return false|string * @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 ) { public function get_contents( $file ) {
$tempfile = wp_tempnam($file); $tempfile = wp_tempnam($file);

View File

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