How to use pre_move_uploaded_file filter in WordPress

pre_move_uploaded_file filter

If a non-null value is returned from the filter, moving the file and any related error reporting will be completely skipped.

To use pre_move_uploaded_file filter, first you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at Flipper Code, always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function modify_pre_move_uploaded_file_defaults which takes 4 parameters and we registered using add_filter. The first parameter pre_move_uploaded_file is name of the hook, The second parameter modify_pre_move_uploaded_file_defaults is name of the function which need to be called, third parameter is the priority of calling the hook if same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometime, you have to remove a registered hook so you can use remove_filter to remove pre_move_uploaded_file filter.

Parameters

Below are the 4 parameters are required to use this hook.

• $move_new_file : (mixed) If null (default) move the file after the upload.
• $file : (array) Reference to a single element from $_FILES.
  ‘name’
  (string) The original name of the file on the client machine.
  ‘type’
  (string) The mime type of the file, if the browser provided this information.
  ‘tmp_name’
  (string) The temporary filename of the file in which the uploaded file was stored on the server.
  ‘size’
  (int) The size, in bytes, of the uploaded file.
  ‘error’
  (int) The error code associated with this file upload.
• $new_file : (string) Filename of the newly-uploaded file.
• $type : (string) Mime type of the newly-uploaded file.

Live Example

apply_filters( 'pre_move_uploaded_file', mixed $move_new_file, array $file, string $new_file, string $type )

Below is an example how you can use this hook.

                        function modify_pre_move_uploaded_file_defaults($move_new_file, $file, $new_file, $type) { 
   
                            // Update the $move_new_file variable according to your website requirements and return this variable. You can modify the $move_new_file variable conditionally too if you want.

                            return $move_new_file; 
                        }
                        // add the filter
                        add_filter( "pre_move_uploaded_file", "modify_pre_move_uploaded_file_defaults", 10, 4 );

To remove a hook callback, use the example below.

remove_filter( "pre_move_uploaded_file", "modify_pre_move_uploaded_file_defaults", 10, 4 );

Please make sure provide the same callback function name, priority and number of arguments while removing the hook callback.

Flipper Code is a Premium WordPress Plugins development company and integrating new functionalites into WordPress sites in form of custom WordPress Plugins since 2012. If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.