WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Filesystem_SSH2::get_contents()

WP_Filesystem_SSH2::get_contents( string $file ): string|false

In this article

Back to top

Reads entire file into a string.

Parameters

$filestringrequired
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

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

View all references View on Trac View on GitHub

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

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

Used byDescription
WP_Filesystem_SSH2::copy()wp-admin/includes/class-wp-filesystem-ssh2.php

Copies a file.

Changelog

VersionDescription
2.7.0Introduced.

User Contributed Notes

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