WP_Filesystem_FTPext::put_contents( string $file, string $contents, int|false $mode = false ): bool
- Since
- 2.5.0
- Source
wp-admin/includes/class-wp-filesystem-ftpext.php:188
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- Remote path to the file where to write the data.
$contentsstring- The data to write.
$modeint|falseoptional- The file permissions as octal number, usually 0644.
Default false.Default:false
Return value
bool- True on success, false on failure.
Performance profile
How much work a call to WP_Filesystem_FTPext::put_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
- Constant
- Instructions
- 17–49
- Plugin surface
- None
- Called by
- 1
Reads or writes the filesystem via fopen().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 60.
Nothing here hands control to plugin code.
1 place 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::put_contents() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 17 | wp_tempnam(), fopen(), unlink() |
$data_length !== false | 31 | wp_tempnam(), fopen(), mbstring_binary_safe_encoding(), fwrite(), reset_mbstring_encoding(), fclose(), unlink() |
$data_length === false | 49 | wp_tempnam(), fopen(), mbstring_binary_safe_encoding(), fwrite(), reset_mbstring_encoding(), fseek(), ftp_fput(), fclose(), unlink(), ->chmod() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 60 | 17–49 | 2 | |
| 8.5 | 60 | 17–49 | 2 | |
| 8.4 | 60 | 17–49 | 2 | |
| 8.3 | 60 | 17–49 | 2 | |
| 8.2 | 60 | 17–49 | 2 | 3 more instructions than PHP 8.1 |
| 8.1 | 57 | 17–46 | 2 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 58 | 17–47 | 2 |
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 · 4
- wp_tempnam()Returns a filename of a temporary unique file.
- mbstring_binary_safe_encoding()Sets the mbstring internal encoding to a binary safe encoding when func_overload is enabled.
- reset_mbstring_encoding()Resets the mbstring internal encoding to a users previously set encoding.
- WP_Filesystem_FTPext::chmod()Changes filesystem permissions.
Used by · 1
- WP_Filesystem_FTPext::copy()Copies a file.
Source code
public function put_contents( $file, $contents, $mode = false ) { $tempfile = wp_tempnam( $file ); $temphandle = fopen( $tempfile, 'wb+' ); if ( ! $temphandle ) { unlink( $tempfile ); return false; } mbstring_binary_safe_encoding(); $data_length = strlen( $contents ); $bytes_written = fwrite( $temphandle, $contents ); reset_mbstring_encoding(); if ( $data_length !== $bytes_written ) { fclose( $temphandle ); unlink( $tempfile ); return false; } fseek( $temphandle, 0 ); // Skip back to the start of the file being written to. $ret = ftp_fput( $this->link, $file, $temphandle, FTP_BINARY ); fclose( $temphandle ); unlink( $tempfile ); $this->chmod( $file, $mode ); return $ret; }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.8.8 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.