WP_Filesystem_SSH2::put_contents( string $file, string $contents, int|false $mode = false ): bool

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

bool

True on success, false on failure.

Uses · 2

• WP_Filesystem_SSH2::sftp_path()Gets the ssh2.sftp PHP stream wrapper path to open for the given file.
• WP_Filesystem_SSH2::chmod()Changes filesystem permissions.

Used by · 1

• WP_Filesystem_SSH2::copy()Copies a file.

Source

View on Trac ↗View on GitHub ↗

335	public function put_contents( $file, $contents, $mode = false ) {336		$ret = file_put_contents( $this->sftp_path( $file ), $contents );337 338		if ( strlen( $contents ) !== $ret ) {339			return false;340		}341 342		$this->chmod( $file, $mode );343 344		return true;345	}

History

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/class-wp-filesystem-ssh2.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.