pre_wp_unique_filename_file_list │ filter-hook │ WP 5.5.0

Filters the file list used for calculating a unique filename for a newly added file.

Returning an array from the filter will effectively short-circuit retrieval from the filesystem and return the passed value instead.

Usage

add_filter( 'pre_wp_unique_filename_file_list', 'wp_kama_pre_wp_unique_filename_file_list_filter', 10, 3 );

/**
 * Function for `pre_wp_unique_filename_file_list` filter-hook.
 * 
 * @param array|null $files    The list of files to use for filename comparisons.
 * @param string     $dir      The directory for the new file.
 * @param string     $filename The proposed filename for the new file.
 *
 * @return array|null
 */
function wp_kama_pre_wp_unique_filename_file_list_filter( $files, $dir, $filename ){

	// filter...
	return $files;
}

$files(array|null)

The list of files to use for filename comparisons.
Default: null (to retrieve the list from the filesystem)

$dir(string)

The directory for the new file.

$filename(string)

The proposed filename for the new file.

Changelog

Where the hook is called

$files = apply_filters( 'pre_wp_unique_filename_file_list', null, $dir, $filename );

Where the hook is used in WordPress