This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

_copy_image_file( string $attachment_id )

Copy an existing image file.

Parameters

$attachment_id

(string) (Required) Attachment ID.

Return

(string|false) New file path on success, false on failure.

Source

File: wp-admin/includes/image.php 

function _copy_image_file( $attachment_id ) {
	$dst_file = $src_file = get_attached_file( $attachment_id );
	if ( ! file_exists( $src_file ) )
		$src_file = _load_image_to_edit_path( $attachment_id );

	if ( $src_file ) {
		$dst_file = str_replace( basename( $dst_file ), 'copy-' . basename( $dst_file ), $dst_file );
		$dst_file = dirname( $dst_file ) . '/' . wp_unique_filename( dirname( $dst_file ), basename( $dst_file ) );

		/*
		 * The directory containing the original file may no longer
		 * exist when using a replication plugin.
		 */
		wp_mkdir_p( dirname( $dst_file ) );

		if ( ! @copy( $src_file, $dst_file ) )
			$dst_file = false;
	} else {
		$dst_file = false;
	}

	return $dst_file;
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/post.php: get_attached_file()

Retrieve attached file path based on attachment ID.
wp-includes/functions.php: wp_unique_filename()

Get a filename that is sanitized and unique for the given directory.
wp-includes/functions.php: wp_mkdir_p()

Recursive directory creation based on full path.
wp-admin/includes/image.php: _load_image_to_edit_path()

Retrieve the path or url of an attachment’s attached file.

Changelog

Changelog
Version Description
WP-3.4.0 Introduced.