WP_Filesystem_SSH2::get_contents() WordPress Method

The WP_Filesystem_SSH2::get_contents() function is used to retrieve the contents of a given file using an SSH2 connection. This is useful for accessing remote files or for retrieving sensitive data from a secure server.

WP_Filesystem_SSH2::get_contents( string $file ) #

Reads entire file into a string.


Parameters

$file

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


Top ↑

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

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

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


Top ↑

Changelog

Changelog
VersionDescription
2.7.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.