説明
array wp_upload_bits( string $name, null $deprecated, mixed $bits [ , string $time = null ] )
データをアップロードファイルとして保存する。
パラメータ
- $nameファイル名を指定。
- $deprecated必ずnullを指定。
- $bits保存するデータを指定。
- $time保存先のサブディレクトリ（yyyy/mm）を指定（省略時はnull）。
返り値
アップロード結果を格納した連想配列を返す。正しく保存できた場合はキー'error'の値にfalseが、保存に失敗した場合はその理由のテキストが格納され、キー'file'や'url'の値は存在しない。| キー | 内容 |
|---|---|
| 'file' | アップロードファイルのフルパス名 |
| 'url' | アップロードファイルのURL |
| 'error' | エラー内容（保存できた場合はfalse） |
注意
この関数はあくまでもデータをアップロード先ディレクトリに保存するだけで、メディア（attachment）として登録されるわけではない。
アップロード先に同名のファイルが存在する場合は、ファイル名の拡張子前に数字を追加して重複しないようになるため、保存されるファイル名はパラメータ$nameと異なる場合がある。例えば、パラメータ$nameに'a.txt'が指定され、保存先のディレクトリに同名のファイルが存在する場合は、'a1.txt'、a2.txt'、a3.txt'の順にファイルが存在するか調べ、存在しなかった名前が最終的なファイル名となる。
アップロードしたファイルのステータスは、アップロード先ディレクトリのステータスに依存する。
使用例
- データ$dataをファイル名'log20141127_123456.txt'で保存する。
<?php $upload = wp_upload_bits( 'log20141127_123456.txt', null, $data ); if ( empty( $upload['error'] ) ) { // アップロード成功時の処理 } ?> - データ$dataを2014年9月のディレクトリにファイル名'log20141127_123456.txt'で保存する。<?php $upload = wp_upload_bits( 'log20141127_123456.txt', null, $data, '2014/09' ); ?>
フィルター
[3.0.0]アップロード先ディレクトリを確認した後に'wp_upload_bits'フィルターを呼び出す。パラメータ$argsは本関数が受け取った$name、$bits、$timeが格納された連想配列となる。$upload_bits_error = apply_filters( 'wp_upload_bits', $args );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/functions.php最終更新 : 2018年05月27日 10:46
関連
お勧め
子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）
少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。投稿内容に応じてwpautopを制御する（2013年8月13日 更新）
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。
親子の固定ページで同じテンプレートを使う（2013年3月20日 更新）
固定ページのテンプレートファイルは「page.php」か、ページ名（スラッグ）または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。管理画面でツールバー（Admin bar）を非表示にする（2013年3月5日 更新）
WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。カスタムフィールド関連関数のおさらい（2012年6月22日 更新）
カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。