User Contributed Notes

1. Skip to note 2 content

   
   Aurovrata Venet
   
   
   3 years ago
   

   You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

   There is an interesting question on this filter in the support forum with a rather complicated reply, however, I have to use this for a slightly different problem.

   I normally use the function media_handle_sideload() to move a file into the wp uploads fodler and save it as a media attachment post, which works quite nicely.

   However, recently I had to copy a file (rather than move it), in my plugin extension as the original plugin still needed to have access to the original file location (a temporary folder on the fs), and unfortunately there is no way to get the media_handle_sideload() to copy rather than move a file.

   This is where this filter comes in handy. The media_handle_sideload() makes use of the wp_handle_sideload(), which in turns calls the _wp_handle_upload() function, within which the pre_move_uploaded_file filter is applied.

   The filter can be used to switch off the actual moving of the file while retaining all the goodness of validation that the function handles, allowing one to handle the actual file handling, copying it instead of moving it in my case. This is how I used it,

   // first step is to identify the filename and path you want to copy. 
   $file_arr = array(
   	'name'     => $filename, //something like my-photo.jpg
   	'tmp_name' => $path, //something like /..../wp-content/uploads/cf7-uploads/tmp/my-photo.jpg
   );
   
   // next use a unique action handle to identify your file process from others handled by WP core/plugins.
   $action = 'wpdocs_file_copy';
   
   // this allows to identify your file action with the filter applied at the start of _wp_handle_upload().
   // register your file handling process with an anonymous function.
   add_filter( "{$action}_prefilter", function( $file ) {
   	// next we hook the filter to cancel the file move.
   	add_filter( 'pre_move_uploaded_file', function( $move, $file, $new_file ) {
   	
   		// now you copy your file, knowing that the $new_file path has been validated by WP.
   		$move = @copy( $file['tmp_name'], $new_file );
   		
   		if ( false === $move && WP_DEBUG ) {
   			trigger_error( ... ); // handle the error (optional). 
   		}
   		
   		return $move; // either false or true, but not null will cancel the file move.
   	}, 10, 3 ); // pre_move filter
   	
   	return $file;
   } ); // filter
   
   // now you fire the actually file moving process which will validate the new location of the file on the fs and trigger the above filter.
   $new_file_arr = wp_handle_sideload( $file_arr,
   	array(
   		'action'    => $action, // the action defined above.
   		'test_form' => false, // in this case the file I am copying is not coming from the $_FILES submission and so I don't need the extra validation. 
   	),
   	current_time( 'mysql' ) // timestamp.
   );
   
   if ( isset( $new_file_arr['error'] ) ) { //in case there was an error.
   	// handle the error (optional)
   } else {
   	$url      = $new_file_arr['url'];
   	$type     = $new_file_arr['type'];
   	$new_file = $new_file_arr['file'];
   }
   // you can then go on to create an attachment post and link it to a parent post if need be.

   Note, the above only copies the file to the wp-content/uploads/<year>/<month>/ folder structure, but does not actually create an attachment post (required to see your file in the Media section of the dashboard), nor links it to a parent post (eg as a featured/thumbnail image). If you need to see how to do this I suggest you take a look at the process used in the media_handle_sideload() function.