sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Add a summary, version, and parameter and return descriptions to the DocBlock for WP_Filesystem_FTPext::get_contents().

Browse Source 
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
This commit is contained in:
Drew Jaynes 2015-09-24 14:10:47 +00:00
parent 0111ecef55
commit 6ac2cb05e6
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/wp-admin/includes/class-wp-filesystem-ftpext.php
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);