説明
mixed wp_insert_attachment( mixed $args [ , string $file = false[ , int $parent = 0 [ , bool $wp_error = false ] ] ] )
メディア（添付ファイル）を登録する。
パラメータ
- $args投稿情報を連想配列（または文字列）を指定。
- $file添付ファイルのパス名を指定（省略時はfalse）。
- $parent添付元の投稿IDを指定（省略時は0）。
- $wp_error[4.7.0]エラー内容を示すWP_Errorオブジェクトを返す場合はtrueを指定（省略時はfalse）。
返り値
登録できた場合はメディアの投稿IDを返す。登録できなかった場合、パラメータ$wp_errorがtrueの場合は登録失敗内容を示すWP_Errorオブジェクトが、$wp_errorがfalseの場合は0を返す。注意
メディア（添付ファイル）は投稿情報の1つであり、投稿タイプは'attachment'となる。パラメータ$parentが投稿IDの場合はその投稿情報の添付ファイルとして、$parentが0の場合は独立したメディアとして登録する。なおパラメータ$argsには標準の投稿情報のほかにキー'post_mime_type'でファイルのMIMEタイプを指定すること。
[4.7.0]パラメータ$wp_errorが追加され、trueを指定することで登録失敗時の理由を取得できるようになった。
使用例
- ファイルを$post_idで示す投稿情報の添付ファイルとしてする。<?php $id = wp_insert_attachment( $attachment, $filepath, $post_id ); ?>
- ファイルを$post_idで示す投稿情報の添付ファイルとしてする（登録失敗時にその情報を取得）。<?php $id = wp_insert_attachment( $attachment, $filepath, $post_id, true ); ?>
- ファイルを独立したメディアとして登録する。<?php $id = wp_insert_attachment( $attachment, $filepath ); ?>
フィルター
実行するフィルターはありません。アクション
実行するアクションはありません。ソースファイル
/wp-includes/post.php最終更新 : 2018年05月27日 10:42
関連
お勧め
囲み型ショートコードとwpautop（2018年5月27日 更新）
ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。
使っていないか確認しないとね！（フィルター編）（2019年4月24日 更新）
先週末にWordPress 5.2 Beta3（以降5.2Beta3）が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。
Login rebuilder 2.5.0の新機能紹介（2018年12月10日 更新）
今回追加したものは、任意の名前でロックファイルを設定し、そのファイルが存在する場合は常にログイン不可にする機能である。この機能を有効にしておくことで、何らかの理由により認証に関する情報が漏洩した場合でも不正なログインを防ぐことができる。
時代はWP_Queryなのか（2011年8月1日 更新）
WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近まで get_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。query_posts（WP_Queryクラス）で'tax_query'を使いこなす（2011年9月14日 更新）
2日にわたって投稿した「query_posts（WP_Queryクラス）でカテゴリーを絞り込む」「query_posts（WP_Queryクラス）で投稿タグを絞り込む」の続き。今日はカテゴリーや投稿タグ以外ののタクソノミーによる絞り込み、複数のタクソノミーの絞り込みの組み合わせについてまとめてみる。