Уніфікує ім’я файлу. Використовується перед збереженням файлу у вказану папку, щоб змінити його ім’я, якщо файл вже існує.
Якщо файл в такому імені існує в директорії, то функція додасть в кінець імені файлу число і перевірить нове ім’я. І так доти, доки ім’я не стане унікальним. Функція відновить унікальне ім’я файлу.
У третій параметр $unique_filename_callback можна передати назву функції, яка буде унікалізувати ім’я файлу. За промовчанням до назви файлу додаються цифри: name1.jpg , name2.jpg і т.д.
Примітка: wp_unique_filename() автоматично використовує функцію очищення імені файлу sanitize_file_name() .
Шлях до каталогу (директорії), де знаходиться файл.
$filename (рядок) (обов’язковий)
Ім’я файлу (тільки ім’я, не шлях із ім’ям), який потрібно перевірити на унікальність.
$unique_filename_callback (callback)
Назва функції, яка перевірятиме унікальність. За замовчуванням – вбудована функція.
Типово: null
Приклади
0
#1 Унікалізуємо ім’я файлу перед збереженням його до каталогу
Допустимо ми зберігаємо файл file.jpgу каталог /home/filesі там вже є файл із таким ім’ям. Тоді, щоб не перезаписати наявний файл новим, а додати новий файл, ми можемо створити нове унікальне ім’я нальоту, так:
function wp_unique_filename( $dir, $filename, $unique_filename_callback = null ) { // Sanitize file name before we begin processing. $filename = sanitize_file_name($filename); $ext2 = null; // Initialize vars використані в wp_unique_filename filter. $number = ''; $alt_filenames = array(); // Separate filename в name і extension. $ ext = pathinfo ($ filename, PATHINFO_EXTENSION); $name = pathinfo($filename, PATHINFO_BASENAME); if ($ ext) { $ext = '.' . $ext; } // Edge case: if file is named '.ext', treat as an empty name. if ( $name === $ext ) { $name = ''; } /* * Increment file number until we have a unique file to save in $dir. * Use callback if supplied. */ if ( $unique_filename_callback && is_callable( $unique_filename_callback ) ) { $filename = call_user_func($ unique_filename_callback, $dir, $name, $ext); } else { $ fname = pathinfo ($ filename, PATHINFO_FILENAME); // Всім append a number to file names that can potentially match image sub-size file names. if ( $fname && preg_match( '/-(?:d+xd+|scaled|rotated)$/', $fname ) ) { $number = 1; // На цьому пункті файл name не може бути unique. Це тестується нижче і $number incremented. $filename = str_replace( "{$fname}{$ext}", "{$fname}-{$number}{$ext}", $filename ); } /* * Get the mime type. uploaded files були already checked with wp_check_filetype_and_ext() * in _wp_handle_upload(). За допомогою wp_check_filetype() would be sufficient here. */ $file_type = wp_check_filetype( $filename ); $mime_type = $file_type['type']; $is_image = ( ! empty( $mime_type ) && 0 === strpos( $mime_type, 'image/' ) ); $upload_dir = wp_get_upload_dir(); $lc_filename = null; $lc_ext = strtolower( $ext ); $_dir = trailingslashit($dir); /* * Якщо extension is uppercase add an alternate file name with lowercase extension. * Both потрібен, щоб був tested для uniqueness as the extension will be changed to lowercase * для більшої надійності з різними файламисистем. Fixes an inconsistency in WP < 2.9 * where uppercase extensions були дозволені, але зображення sub-sizes були створені з * Lowercase extensions. */ if ( $ext && $lc_ext !== $ext ) { $lc_filename = preg_replace( '|' . preg_quote( $ext ) . '$|', $lc_ext, $filename ); } /* * Increment the number added to file name if there are any files in $dir * Whose names match один з можливих назв variations. */ while ( file_exists( $_dir . $filename ) || ( $lc_filename && file_exists( $_dir . $lc_filename ) ) ) { $new_number = (int) $number + 1; if ($lc_filename) { $lc_filename = str_replace( array( "-{$number}{$lc_ext}", "{$number}{$lc_ext}" ), "-{$new_number}{$lc_ext}", $lc_filename ); } if ( '' === "{$number}{$ext}" ) { $filename = "{$filename}-{$new_number}"; } else { $filename = str_replace( array( "-{$number}{$ext}", "{$number}{$ext}" ), "-{$new_number}{$ext}", $filename ); } $number = $new_number; } // Зміна extension to lowercase if needed. if ($lc_filename) { $filename = $lc_filename; } /* * Prevent collisions with existing file names that contain dimension-like strings * (Whether they є subsizes or originals uploaded prior to #42437). */ $files = array(); $ count = 10000; // The (resized) image files would have name і extension, and will be in the uploads dir. if ( $name && $ext && @is_dir( $dir ) && false !== strpos( $dir, $upload_dir['basedir'] ) ) { /** * Filters file list use for calculating unique filename for newly added file. * * Returning array from filter will effectively short-circuit retrieval * З файлусистеми і відновлення passed value instead. * * @ Since 5.5.0 * * @param array|null $files List of files to use for filename comparisons. * Default null (to retrieve the list from the filesystem). * @param string $dir Зареєструватись для нового файлу. * @param string $filename Розширений файл файлу для нового файлу. */ $files = apply_filters( 'pre_wp_unique_filename_file_list', null, $dir, $filename ); if ( null === $files ) { // List of all files and directories містить $dir. $files = @scandir($dir); } if ( ! empty( $files ) ) { // Remove "dot" dirs. $files = array_diff( $files, array( '.', '..' ) ); } if ( ! empty( $files ) ) { $ count = count ($ files); /* * Використання цих невідомих слів в infinite loop, як це використовується pathinfo() і regex in the check, * but string replacement for the changes. */ $i = 0; while ( $i <= $count && _wp_check_existing_file_names( $filename, $files ) ) { $new_number = (int) $number + 1; // If $ext is uppercase it was replaced with the lowercase version after the previous loop. $filename = str_replace( array( "-{$number}{$lc_ext}", "{$number}{$lc_ext}" ), "-{$new_number}{$lc_ext}", $filename ); $number = $new_number; $i++; } } } /* * Check if an image will be converted after uploading or some existing image sub-size file names may conflict * Коли regenerated. Якщо ви, натисніть на новий файл ім'я буде бути unique і буде виробляти unique sub-sizes. */ if ($ is_image) { /** Цей filter is documented в wp-includes/class-wp-image-editor.php */ $output_formats = apply_filters( 'image_editor_output_format', array(), $_dir . $filename, $mime_type ); $alt_types = array(); if ( ! empty( $output_formats [ $ mime_type ] ) ) { // The image will be converted to this format/mime type. $alt_mime_type = $output_formats[ $mime_type ]; // Інші типи зображень, які назви можуть бути впевнені, що їх sub-sizes є regenerated. $alt_types = array_keys( array_intersect( $output_formats, array( $mime_type, $alt_mime_type ) ) )); $alt_types[] = $alt_mime_type; } elseif (! empty($output_formats)) { $alt_types = array_keys( array_intersect( $output_formats, array( $mime_type ) ) )); } // Remove duplicates and the original mime type. It will be added later if needed. $alt_types = array_unique( array_diff( $alt_types, array( $mime_type ) ) )); foreach ( $alt_types as $alt_type ) { $alt_ext = wp_get_default_extension_for_mime_type( $alt_type ); if (! $alt_ext) { continue; } $alt_ext = ".{$alt_ext}"; $alt_filename = preg_replace( '|' . preg_quote( $lc_ext ) . '$|', $alt_ext, $filename ); $alt_filenames[ $alt_ext ] = $alt_filename; } if ( ! empty( $alt_filenames ) ) { /* * Add the original filename. It needs to be checked again * Включити з іншим файлом файлів, коли $number is incremented. */ $alt_filenames[ $lc_ext ] = $filename; // Ensure no infinite loop. $i = 0; while ( $i <= $count && _wp_check_alternate_file_names( $alt_filenames, $_dir, $files ) ) { $new_number = (int) $number + 1; foreach ( $alt_filenames as $alt_ext => $alt_filename ) { $alt_filenames[ $alt_ext ] = str_replace( array( "-{$number}{$alt_ext}", "{$number}{$alt_ext}" ), "-{$new_number}{$alt_ext}", $alt_filename ); } /* * Also update $number in (output) $filename. * If the extension був uppercase it був already replaced with the lowercase version. */ $filename = str_replace( array( "-{$number}{$lc_ext}", "{$number}{$lc_ext}" ), "-{$new_number}{$lc_ext}", $filename ); $number = $new_number; $i++; } } } } /** * Filters the result when generating a unique file name. * * @ Since 4.5.0 * @since 5.8.1 The `$alt_filenames` and `$number` parameters були 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 що generates the unique file name. * @param string[] $alt_filenames Array of alternate file names that були checked for collisions. * @param int|string $number High number that was used to make the file name unique * or an empty string if unused. */ return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback, $alt_filenames, $number ); }