WordPress at Your Fingertips
function is not described

WP_Filesystem_ftpsockets::put_contents() public WP 2.5.0

Writes a string to a file.

{} It's a method of the class: WP_Filesystem_ftpsockets{}

No Hooks.

Return

true|false. True on success, false on failure.

Usage

$WP_Filesystem_ftpsockets = new WP_Filesystem_ftpsockets();
$WP_Filesystem_ftpsockets->put_contents( $file, $contents, $mode );
$file(string) (required)
Remote path to the file where to write the data.
$contents(string) (required)
The data to write.
$mode(int|false)
The file permissions as octal number, usually 0644.
Default: false

Changelog

Since 2.5.0 Introduced.

Code of WP_Filesystem_ftpsockets::put_contents() WP 5.8.2

public function put_contents( $file, $contents, $mode = false ) {
	$tempfile   = wp_tempnam( $file );
	$temphandle = @fopen( $tempfile, 'w+' );

	if ( ! $temphandle ) {
		unlink( $tempfile );
		return false;
	}

	// The FTP class uses string functions internally during file download/upload.
	mbstring_binary_safe_encoding();

	$bytes_written = fwrite( $temphandle, $contents );

	if ( false === $bytes_written || strlen( $contents ) !== $bytes_written ) {
		fclose( $temphandle );
		unlink( $tempfile );

		reset_mbstring_encoding();

		return false;
	}

	fseek( $temphandle, 0 ); // Skip back to the start of the file being written to.

	$ret = $this->ftp->fput( $file, $temphandle );

	reset_mbstring_encoding();

	fclose( $temphandle );
	unlink( $tempfile );

	$this->chmod( $file, $mode );

	return $ret;
}