wp_unique_filename

説明

string wp_unique_filename( string $dir, string $filename [ , mixed $unique_filename_callback = null ] )
ユニークなファイル名を取得する。

パラメータ

  • $dir
    ディレクトリ名を指定。
  • $filename
    ファイル名を指定。
  • $unique_filename_callback
    ユニークなファイル名を生成するコールバック関数を指定(省略時はnull)。

返り値

ユニークなファイル名を返す。

注意

パラメータ$unique_filename_callbacknullでディレクトリに同名のファイルが存在する場合は、ファイル名の拡張子前に数字を追加したものを順に調べ、存在しなかった名前が返り値となる。例えば、パラメータ$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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。