WP_Filesystem_SSH2::copy( string $source, string $destination, bool $overwrite = false, int|false $mode = false ): bool

Parameters

$sourcestring

Path to the source file.

$destinationstring

Path to the destination file.

$overwritebooloptional

Whether to overwrite the destination file if it exists. Default false.Default: false

$modeint|falseoptional

The permissions as octal number, usually 0644 for files, 0755 for dirs. Default false.Default: false

Return

bool

True on success, false on failure.

Uses · 3

• WP_Filesystem_SSH2::exists()Checks if a file or directory exists.
• WP_Filesystem_SSH2::get_contents()Reads entire file into a string.
• WP_Filesystem_SSH2::put_contents()Writes a string to a file.

Source

View on Trac ↗View on GitHub ↗

545	public function copy( $source, $destination, $overwrite = false, $mode = false ) {546		if ( ! $overwrite && $this->exists( $destination ) ) {547			return false;548		}549 550		$content = $this->get_contents( $source );551 552		if ( false === $content ) {553			return false;554		}555 556		return $this->put_contents( $destination, $content, $mode );557	}

History

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/class-wp-filesystem-ssh2.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.