WP_Filesystem_SSH2::run_command

Advertisement

Syntax Syntax

WP_Filesystem_SSH2::run_command( string $command, bool $returnbool = false )

Parameters Parameters

$command

(string) (Required)

$returnbool

(bool) (Optional)

Default value: false

Return 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 Source

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

		$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;
	}

	/**
	 * Reads entire file into a string.

Advertisement

Changelog Changelog

Changelog
Version Description
2.7.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

What are you looking for?