説明
string wp_unique_filename( string $dir, string $filename [ , mixed $unique_filename_callback = null ] )
ユニークなファイル名を取得する。
パラメータ
- $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'フィルターが追加された。
使用例
- ディレクトリ$pathにて'log20141127_123456.txt'のユニークなファイル名を取得する。<?php $filename = wp_unique_filename( $path, 'log20141127_123456.txt' ); ?>
フィルター
[5.5.0]ディレクトリのファイルリストを取得する前に'pre_wp_unique_filename_file_list'フィルターを呼び出す。フィルターの返り値がnullの場合は従来通りディレクトリのファイルリストが取得され、配列の場合はその内容がそのディレクトリのファイルリストとなる。パラメータ$filesにはnullが、$dirには本関数が受け取った内容が、$filenameにはサニタイズされた内容が格納されている。$files = apply_filters( 'pre_wp_unique_filename_file_list', $files, $dir, $filename );return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback );アクション
実行するアクションはありません。ソースファイル
/wp-includes/functions.php最終更新 : 2020年08月17日 15:55
関連
お勧め
wp_titleからwp_get_document_titleへ（2018年5月27日 更新）
先週、WordPress 4.4 beta1（以降4.4 beta1）が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。
ツイート引用が簡単になる仕組み（2012年6月8日 更新）
WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。5.5の機能強化：テーマ変更時に要求バージョンを確認（2020年8月12日 更新）
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2（以降RC 2）」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
サイトヘルス機能を使ってみた（2019年4月12日 更新）
先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2（以降5.2Beta2）が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。
ブロックエディターで編集したページが出力した余分な改行を削除（2019年2月22日 更新）
ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。