説明
パラメータ
- $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が格納された連想配列となる。アクション
実行するアクションはありません。ソースファイル
/wp-includes/functions.php最終更新 : 2018年05月27日 10:46
関連
お勧め
wp_titleからwp_get_document_titleへ(2018年5月27日 更新)
先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。
ツイート引用が簡単になる仕組み(2012年6月8日 更新)
WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
サイトヘルス機能を使ってみた(2019年4月12日 更新)
先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。
ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)
ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。