WP_Filesystem_Direct::put_contents() WordPress Method

The WP_Filesystem_Direct::put_contents() method is used to write a string of data to a file. This is a wrapper for the PHP function file_put_contents().

WP_Filesystem_Direct::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


Top ↑

Return

(bool) True on success, false on failure.


Top ↑

Source

File: wp-admin/includes/class-wp-filesystem-direct.php

	public function put_contents( $file, $contents, $mode = false ) {
		$fp = @fopen( $file, 'wb' );

		if ( ! $fp ) {
			return false;
		}

		mbstring_binary_safe_encoding();

		$data_length = strlen( $contents );

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

		reset_mbstring_encoding();

		fclose( $fp );

		if ( $data_length !== $bytes_written ) {
			return false;
		}

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

		return true;
	}


Top ↑

Changelog

Changelog
VersionDescription
2.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.