WP_Filesystem_ftpsockets::get_contents( string $file )

Retrieves the file contents.


Description Description


Parameters Parameters

$file

(string) (Required) Filename.


Top ↑

Return Return

(string|false) File contents on success, false if no temp file could be opened, or if the file doesn't exist.


Top ↑

Source Source

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

	public function get_contents( $file ) {
		if ( ! $this->exists( $file ) ) {
			return false;
		}

		$temp = wp_tempnam( $file );

		if ( ! $temphandle = fopen( $temp, 'w+' ) ) {
			unlink( $temp );
			return false;
		}

		mbstring_binary_safe_encoding();

		if ( ! $this->ftp->fget( $temphandle, $file ) ) {
			fclose( $temphandle );
			unlink( $temp );

			reset_mbstring_encoding();

			return ''; // Blank document, File does exist, It's just blank.
		}

		reset_mbstring_encoding();

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

		while ( ! feof( $temphandle ) ) {
			$contents .= fread( $temphandle, 8192 );
		}

		fclose( $temphandle );
		unlink( $temp );
		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.