wp_insert_attachment() の使い方説明・引数・注意点
wp_insert_attachment() は、ファイルをメディアライブラリに登録する関数です。
説明
wp_insert_attachment() は、ファイルをメディアライブラリに登録する関数です。
基本構文
wp_insert_attachment( array|string $args, string|false $file = false, int $parent_post_id = 0, bool $wp_error = false, bool $fire_after_hooks = true ): int|WP_Error
引数
$args:post_title、post_mime_typeなどの配列$file:ファイルのパス$parent_post_id:親投稿のID$wp_error:失敗時にWP_Errorを返すか
戻り値
添付ファイルのID。失敗時は 0 または WP_Error。
使い方(サンプル)
$id = wp_insert_attachment( array(
'post_title' => 'サンプル画像',
'post_mime_type' => 'image/jpeg',
'post_status' => 'inherit',
), $file, 123 );
注意点
- 登録後に
wp_generate_attachment_metadata()でメタデータを作ります。 - ファイルは事前にアップロードディレクトリに置く必要があります。
実務での使いどころ
- すでにアップロードフォルダにあるファイルを、メディアとして登録するとき。
- プログラムで作成した画像や、外部から取り込んだファイルを、メディアに追加するとき。
よくあるミスと対策
- ファイルが、アップロードフォルダの中にない。
- 登録しただけで、サムネイルが作られない。
wp_generate_attachment_metadata()とwp_update_attachment_metadata()を続けて呼ぶ。 post_mime_typeを指定していない。- 戻り値が
0やWP_Errorのときを、考えていない。
NG例
$id = wp_insert_attachment( array( 'post_title' => '画像' ), $file ); // MIMEタイプがない。サムネイルもない
OK例
$id = wp_insert_attachment( array(
'post_mime_type' => 'image/jpeg',
'post_title' => '画像',
'post_status' => 'inherit',
), $file );
if ( $id ) {
require_once ABSPATH . 'wp-admin/includes/image.php';
wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $file ) );
}
使い分け早見表
| 関数 | 役割 |
|---|---|
wp_insert_attachment() |
ファイルを、メディアとして登録する |
wp_generate_attachment_metadata() |
サムネイルを生成する |
media_handle_upload() |
アップロードから、登録・サムネイル生成まで、まとめて行う |
PR エックスサーバー
WordPressを、速く・止まらずに運営したい方へ
サーバー選びを間違えると、表示が遅い・サイトが止まるリスクがあります
こんなお悩みはありませんか?
- どのレンタルサーバーを選べばよいか分からない
- 表示が遅い・サイトが落ちるのが心配
- WordPressの設定やセキュリティに自信がない
サーバーは、あとから乗り換えると、データの移行やドメインの設定に手間がかかります。表示が遅い、突然止まるといったトラブルは、訪問者が離れる原因にもなります。最初に、稼働率の保証や実績を確認して選ぶのが安全です。
エックスサーバーなら、WordPressの運営に強いレンタルサーバーを、迷わず選べます。国内でWordPressを利用して運用されているサイトの集計(Dataprovider.com調べ、2025年6月)で、国内シェアNo.1と公式サイトに記載されています。
選ばれるポイント
- WordPressサイトの国内シェアNo.1。実績で選びたいときの安心材料(Dataprovider.com調べ、2025年6月)
- サイトが止まりにくい。月間稼働率99.99%以上を保証し、下回ると月額費用の一部を返金
- 攻撃に強い。WordPressを狙った攻撃の99%以上を未然に防ぐ機能(2024年9月15日〜11月15日の当社調べ)
- ドメイン代を節約できる。独自ドメインが永久無料(対象ドメイン・契約期間などの条件あり)
- テーマ選びも安心。人気テーマ「Cocoon」の開発・提供元が運営
- 10日間の無料お試しで、契約前に操作や表示の速さを確かめられる
10日間の無料お試しで、契約前に試せます
10日間無料でお試し
広告(アフィリエイト)を含みます。特長は2026年11月8日時点の公式サイトの記載で、数値・順位は各調査・調べの時点のものです。料金・条件は公式サイトでご確認ください。
関連項目
wp_generate_attachment_metadata()、media_handle_upload()
公式リファレンス:wp_insert_attachment() | Function | WordPress Developer Resources
本記事は情報提供を目的としています。WordPress本体やテーマ・プラグインのバージョンによって動作が異なる場合があるため、本番環境に反映する前に、必ずテスト環境で動作を確認してください。