WP_Filesystem_SSH2::run_command() WordPress Method
The SSH2::run_command() method is used to execute a command on a remote server via an SSH connection. This method returns the output of the command as a string.
WP_Filesystem_SSH2::run_command( string $command, bool $returnbool = false ) #
Parameters
- $command
(string)(Required)
- $returnbool
(bool)(Optional)
Default value: false
Return
(bool|string) True on success, false on failure. String if the command was executed, $returnbool
is false (default), and data from the resulting stream was retrieved.
Source
File: wp-admin/includes/class-wp-filesystem-ssh2.php
public function run_command( $command, $returnbool = false ) { if ( ! $this->link ) { return false; } $stream = ssh2_exec( $this->link, $command ); if ( ! $stream ) { $this->errors->add( 'command', sprintf( /* translators: %s: Command. */ __( 'Unable to perform command: %s' ), $command ) ); } else { stream_set_blocking( $stream, true ); stream_set_timeout( $stream, FS_TIMEOUT ); $data = stream_get_contents( $stream ); fclose( $stream ); if ( $returnbool ) { return ( false === $data ) ? false : '' !== trim( $data ); } else { return $data; } } return false; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.7.0 | Introduced. |