wp_upload_bits:WordPress私的マニュアル

wp_upload_bits

(2.0.0以降)
wp_upload_bits - データをアップロードファイルとして保存する

説明

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

参考

Code Reference: wp_upload_bits

wp_upload_bits

説明

パラメータ

返り値

注意

使用例

フィルター

アクション

ソースファイル

関連

参考

お勧めコンテンツ