Filter hook 'wp_unique_filename'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into wp_unique_filename
add_filter('wp_unique_filename', 'my_custom_filter', 10, 6);

function my_custom_filter($filename, $ext, $dir, $unique_filename_callback, $alt_filenames, $number) {
    // Your custom filtering logic here
    return $filename;
}

Source Code Context

<?php
2792  	 * @param callable|null $unique_filename_callback Callback function that generates the unique file name.
2793  	 * @param string[]      $alt_filenames            Array of alternate file names that were checked for collisions.
2794  	 * @param int|string    $number                   The highest number that was used to make the file name unique
2795  	 *                                                or an empty string if unused.
2796  	 */
2797  	return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback, $alt_filenames, $number );
2798  }
2799  
2800  /**
2801   * Helper function to test if each of an array of file names could conflict with existing files.
2802   *

PHP Documentation

<?php
/**
	 * Filters the result when generating a unique file name.
	 *
	 * @since 4.5.0
	 * @since 5.8.1 The `$alt_filenames` and `$number` parameters were added.
	 *
	 * @param string        $filename                 Unique file name.
	 * @param string        $ext                      File extension. Example: ".png".
	 * @param string        $dir                      Directory path.
	 * @param callable|null $unique_filename_callback Callback function that generates the unique file name.
	 * @param string[]      $alt_filenames            Array of alternate file names that were checked for collisions.
	 * @param int|string    $number                   The highest number that was used to make the file name unique
	 *                                                or an empty string if unused.
	 */