説明
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
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利（2023年3月30日 更新）
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル（post_title）、本文（post_content）、抜粋（post_excerpt）が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する（2013年3月9日 更新）
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日 更新）
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo：プラグイン作ってみました（2019年9月19日 更新）
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。