wp_unique_filename

パラメータ

• $dir
  ディレクトリ名を指定。
• $filename
  ファイル名を指定。
• $unique_filename_callback
  ユニークなファイル名を生成するコールバック関数を指定（省略時はnull）。

返り値

注意

パラメータ$unique_filename_callbackがnullでディレクトリに同名のファイルが存在する場合は、ファイル名の拡張子前に数字を追加したものを順に調べ、存在しなかった名前が返り値となる。例えば、パラメータ$filenameに'a.txt'が指定され、保存先のディレクトリに同名のファイルが存在する場合は、'a1.txt'、'a2.txt'、'a3.txt'の順にファイルが存在するか調べられる。

パラメータ$unique_filename_callbackに有効な関数が指定されている場合は、その関数の返り値が本関数の返り値となる。

[5.5.0]対象ディレクトリにとても多くのファイルが存在する場合、本関数の処理は時間がかかってしまう。この課題を解決するため、'pre_wp_unique_filename_file_list'フィルターが追加された。

[5.8.1]

使用例

• ディレクトリ$pathにて'log20141127_123456.txt'のユニークなファイル名を取得する。
  <?php $filename = wp_unique_filename( $path, 'log20141127_123456.txt' ); ?>

フィルター

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

return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback, $alt_filenames, $number );

アクション

ソースファイル