WP_Filesystem_SSH2::copy() WordPress Method

The WP_Filesystem_SSH2::copy() function is used to copy a file from one location to another. This function accepts two parameters: the source file and the destination file. The source file must be a valid path to a file on the server and the destination file must be a valid path to a file on the server. This function will return true on success or false on failure.

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

Copies a file.


Parameters

$source

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

$destination

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

$overwrite

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

Default value: false

$mode

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

Default value: false


Top ↑

Return

(bool) True on success, false on failure.


Top ↑

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
VersionDescription
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.