WP_Filesystem_FTPext::get_contents( string $file ): string|false
- Since
- 2.5.0
- Source
wp-admin/includes/class-wp-filesystem-ftpext.php:137
Compatibility
- WordPress
- since 2.5.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$filestring- Name of the file to read.
Return value
string|false- Read data on success, false if no temporary file could be opened, or if the file couldn't be retrieved.
Performance profile
How much work a call to WP_Filesystem_FTPext::get_contents() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Scales with input
- Instructions
- 15–38
- Plugin surface
- None
- Called by
- 2
Reads or writes the filesystem via fopen().
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 56.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- filesystemfilesystem access
fopen()called directly
Further down the call graph this can also reach hook, transient, cache, option, serialize and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Filesystem_FTPext::get_contents() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 15 | wp_tempnam(), fopen(), unlink() |
!ftp_fget() | 28 | wp_tempnam(), fopen(), ftp_fget(), fclose(), unlink() |
ftp_fget() && feof() | 38 | wp_tempnam(), fopen(), ftp_fget(), fseek(), feof(), fclose(), unlink() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 56 | 15–38 | 3 | |
| 8.5 | 56 | 15–38 | 3 | |
| 8.4 | 56 | 15–38 | 3 | |
| 8.3 | 56 | 15–38 | 3 | |
| 8.2 | 56 | 15–38 | 3 | 2 more instructions than PHP 8.1 |
| 8.1 | 54 | 15–36 | 3 | |
| 7.4 | 54 | 15–36 | 3 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- wp_tempnam()Returns a filename of a temporary unique file.
Used by · 2
- WP_Filesystem_FTPext::copy()Copies a file.
- WP_Filesystem_FTPext::get_contents_array()Reads entire file into an array.
Source code
public function get_contents( $file ) { $tempfile = wp_tempnam( $file ); $temphandle = fopen( $tempfile, 'w+' ); if ( ! $temphandle ) { unlink( $tempfile ); return false; } if ( ! ftp_fget( $this->link, $temphandle, $file, FTP_BINARY ) ) { fclose( $temphandle ); unlink( $tempfile ); return false; } fseek( $temphandle, 0 ); // Skip back to the start of the file being written to. $contents = ''; while ( ! feof( $temphandle ) ) { $contents .= fread( $temphandle, 8 * KB_IN_BYTES ); } fclose( $temphandle ); unlink( $tempfile ); return $contents; }Changelog
Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-admin/includes/class-wp-filesystem-ftpext.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.