説明
パラメータ
- $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
関連
お勧め
CSSやJavaScriptファイルのバージョン番号を変える(2018年5月27日 更新)
WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。
テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)
ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。
カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 更新)
カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)
この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。