W3cubDocs

/WordPress

WP_Filesystem_SSH2::get_contents( string $file )

Reads entire file into a string.

Parameters

$file

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

Return

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

Source

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

public function get_contents( $file ) {
		return file_get_contents( $this->sftp_path( $file ) );
	}

Uses

Uses Description
wp-admin/includes/class-wp-filesystem-ssh2.php: WP_Filesystem_SSH2::sftp_path()

Gets the ssh2.sftp PHP stream wrapper path to open for the given file.

Changelog

Version Description
2.7.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_filesystem_ssh2/get_contents