WP_Filesystem_Direct::copy() – Method

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

Copies a file.

Parameters

$sourcestringrequired: Path to the source file.
$destinationstringrequired: Path to the destination file.
$overwritebooloptional: Whether to overwrite the destination file if it exists.

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

Return

bool True on success, false on failure.

Source

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

	$rtval = copy( $source, $destination );

	if ( $mode ) {
		$this->chmod( $destination, $mode );
	}

	return $rtval;
}

View all references View on Trac View on GitHub

Uses	Description
WP_Filesystem_Direct::exists()`wp-admin/includes/class-wp-filesystem-direct.php`	Checks if a file or directory exists.
WP_Filesystem_Direct::chmod()`wp-admin/includes/class-wp-filesystem-direct.php`	Changes filesystem permissions.

Used by	Description
WP_Filesystem_Direct::move()`wp-admin/includes/class-wp-filesystem-direct.php`	Moves a file or directory.

Changelog

Version	Description
2.5.0	Introduced.

User Contributed Notes

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