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

Copies a file.

Parameters Parameters


(string) (Required) Path to the source file.


(string) (Required) Path to the destination file.


(bool) (Optional) Whether to overwrite the destination file if it exists.

Default value: false


(int|false) (Optional) The permissions as octal number, usually 0644 for files, 0755 for dirs.

Default value: false

Top ↑

Return Return

(bool) True on success, false on failure.

Top ↑

Source Source

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

	public function copy( $source, $destination, $overwrite = false, $mode = false ) {
		if ( ! $overwrite && $this->exists( $destination ) ) {
			return false;

		$content = $this->get_contents( $source );

		if ( false === $content ) {
			return false;

		return $this->put_contents( $destination, $content, $mode );

Top ↑

Changelog Changelog

Version Description
2.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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