wp_insert_attachment

パラメータ

• $args
  投稿情報を連想配列（または文字列）を指定。
• $file
  添付ファイルのパス名を指定（省略時はfalse）。
• $parent
  添付元の投稿IDを指定（省略時は0）。
• $wp_error
  [4.7.0]エラー内容を示すWP_Errorオブジェクトを返す場合はtrueを指定（省略時はfalse）。

返り値

注意

メディア（添付ファイル）は投稿情報の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 ); ?>

フィルター

アクション

ソースファイル