wp_unique_filename

説明

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'フィルターが追加された。

[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 );
[4.5.0]ユニークなファイル名を返す前に'wp_unique_filename'フィルターを呼び出す。パラメータ$filenameにはユニークなファイル名が、$extにはピリオド.を含む拡張子が、$dir$unique_filename_callbackには本関数が受け取った内容が格納される。[5.8.1]$alt_filenamesには代替ファイル名の連想配列が、$numberにはユニークファイル名の数字部分が格納される。
return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback, $alt_filenames, $number );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/functions.php

最終更新 : 2021年09月09日 15:46



お勧め

プラグインのロード順を制御する(2014年6月9日 更新)

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

メタボックスをクラシックエディターのみで表示する(2019年1月15日 更新)

投稿画面向けにメタボックスを使ったプラグインがあり、それがブロックエディターで意図した通りに機能しなかった。この対処方法を考える過程でエディタータイプに応じてメタボックスを出し分けできる方法が見つかったので紹介したい。