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



お勧め

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。