wp_upload_dir

(2.0.0以降)
wp_upload_dir - アップロードディレクトリ(パス名)を取得する

説明

array wp_upload_dir( [ string $time = null [ , bool $create_dir = true [ , bool $refresh_cache = false ] ] ] )
アップロードディレクトリ(パス名)を取得する。

パラメータ

  • $time
    年月を'yyyy/mm'の書式で指定(省略時はnull)。
  • $create_dir
    [4.5.0]存在しないディレクトリを作成する場合はtrueを指定(省略時はtrue)。
  • $refresh_cache
    [4.5.0]キャッシュを更新する場合はtrueを指定(省略時はfalse)。

返り値

アップロードパスを格納した連想配列を返す。配列の内容は次の通り。
キー名意味値の例
pathアップロード先のフルパス名C:\Program Files (x86)\Apache Group\Apache2\htdocs\wp/wp-content/uploads/2011/04
urlアップロード先のURLhttp://localhost/wp/wp-content/uploads/2011/04
subdirベースディレクトリからのサブディレクトリ名/2011/04
basedirアップロード先ペースディレクトリのパス名C:\Program Files (x86)\Apache Group\Apache2\htdocs\wp/wp-content/uploads
baseurlアップロード先ペースディレクトリのURLhttp://localhost/wp/wp-content/uploads
errorエラーfalse
※値の例は、Windows環境のもの。

注意

パラメータ$timeを省略した場合は、その時点の日付に基づいたアップロードパスを取得できる。最新(3.1.1)のWordPressのアップロードディレクトリは、デフォルトで年月ベースのディレクトリに整理するようになっており、その年月ペースの部分が連想配列subdirの値となる。この設定は管理者ページの「設定」-「メディア」で確認・変更することができ、プログラムからはget_option( 'uploads_use_yearmonth_folders' )で確認できる。
なおディレクトリが存在しない場合、それらのサブディレクトリを作成するが、作成に失敗した場合には配列のerrorの値にメッセージ(文字列)が格納されるようになっている。

使用例

  • 現在のアップロードディレクトリ(パス名)を取得する。
    <?php $upload_dir = wp_upload_dir(); ?>
  • 2011年3月のアップロードディレクトリを取得する。
    <?php $upload_dir = wp_upload_dir( '2011/03' ); ?>

フィルター

[2.0.0]アップロードディレクトリを作成を試す前に'upload_dir'フィルターを呼び出す。パラメータ$uploadsは返り値となるディレクトリ情報の連想配列となる。
$uploads = apply_filters( 'upload_dir', $uploads );

アクション

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

ソースファイル

/wp-includes/functions.php

関連

お勧めコンテンツ

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 登録)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 登録)

この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。

ページを表示する直前の前処理にtemplate_redirectアクションを(2013年4月13日 登録)

リクエストに応じてページを表示する直前の準備として何かしらの処理を行っておきたいケースがある。そんな時、テーマの各テンプレートファイルの先頭部分に処理内容をずらずらと記述していませんか。

投稿画面のウェジェットを2列にする(2013年1月25日 登録)

ダッシュボード画面ではスクリーンレイアウトを最大4列まで選択できるのに、投稿画面は1列か2列のどちらか。高解像度のディスプレイを使っていると、投稿画面では大画面のメリットを生かせていない理由がここにあるのではと感じ、3列対応にしてみた。

RSSフィードの抜粋をさらに抜粋(2011年7月21日 登録)

RSSフィードはデフォルトでは「全文(HTMLタグを含む)」になっているが、管理画面の「表示設定」では「抜粋のみ(HTMLタグは除外)」を選択できる。それでも投稿記事が長いと、その抜粋テキストも長くなってしまう。ここではそんなRSSフィードの抜粋テキストを調整する方法を紹介する。

最終更新日時 : 2016-04-22 16:52