WP_Filesystem_FTPext::get_contents( string $file )

Reads entire file into a string.


Parameters Parameters

$file

(string) (Required) Name of the file to read.


Top ↑

Return Return

(string|false) Read data on success, false if no temporary file could be opened, or if the file couldn't be retrieved.



Top ↑

Source Source

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

	public function get_contents( $file ) {
		$tempfile = wp_tempnam( $file );
		$temp     = fopen( $tempfile, 'w+' );

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

		if ( ! ftp_fget( $this->link, $temp, $file, FTP_BINARY ) ) {
			fclose( $temp );
			unlink( $tempfile );
			return false;
		}

		fseek( $temp, 0 ); // Skip back to the start of the file being written to.
		$contents = '';

		while ( ! feof( $temp ) ) {
			$contents .= fread( $temp, 8 * KB_IN_BYTES );
		}

		fclose( $temp );
		unlink( $tempfile );
		return $contents;
	}

Top ↑

Changelog Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.