WP_Filesystem_SSH2::put_contents() WordPress Method
The WP_Filesystem_SSH2::put_contents() function is used to write a string of data to a file on a remote server using the SSH2 protocol. This function is useful for writing configuration files or other text-based data to a server.
WP_Filesystem_SSH2::put_contents( string $file, string $contents, int|false $mode = false ) #
Writes a string to a file.
Parameters
- $file
(string)(Required)Remote path to the file where to write the data.
- $contents
(string)(Required)The data to write.
- $mode
(int|false)(Optional) The file permissions as octal number, usually 0644.
Default value: false
Return
(bool) True on success, false on failure.
Source
File: wp-admin/includes/class-wp-filesystem-ssh2.php
public function put_contents( $file, $contents, $mode = false ) { $ret = file_put_contents( $this->sftp_path( $file ), $contents ); if ( strlen( $contents ) !== $ret ) { return false; } $this->chmod( $file, $mode ); return true; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.7.0 | Introduced. |