wp_unique_filename

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

使用例

  • ディレクトリ$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には本関数が受け取った内容が格納される。 
return apply_filters( 'wp_unique_filename', $filename, $ext, $dir, $unique_filename_callback );

アクション

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

ソースファイル

/wp-includes/functions.php

最終更新 : 2020年08月17日 15:55

関連

参考

Code Reference: wp_unique_filename

お勧め

カスタムフィールド関連関数のおさらい（2012年6月22日 更新）

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

MOファイルを作ってみた（2018年7月25日 更新）

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する（2018年5月27日 更新）

標準のログインID（ユーザー名）は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button：プラグイン作ってみました（2017年12月17日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。