説明
パラメータ
- $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]
'wp_unique_filename'フィルターにパラメータ$alt_filenamesと$numberが追加された。使用例
- ディレクトリ$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, $alt_filenames, $number );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/functions.php最終更新 : 2021年09月09日 15:46
関連
お勧め
自動生成される抜粋からテーブルブロックの内容を除外する(2022年4月6日 更新)
標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。
Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)
みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)
管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)
WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。
さくらのVPSでKUSANAGI#2(2018年5月27日 更新)
今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。