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. git-svn-id: https://develop.svn.wordpress.org/trunk@34493 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
parent
0111ecef55
commit
6ac2cb05e6
@ -93,10 +93,14 @@ class WP_Filesystem_FTPext 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 couldn't be retrieved.
|
||||
*/
|
||||
public function get_contents( $file ) {
|
||||
$tempfile = wp_tempnam($file);
|
||||
|
Loading…
Reference in New Issue
Block a user