wp_generate_attachment_metadata() の使い方説明・引数・注意点
wp_generate_attachment_metadata() は、画像の各サイズを生成し、メタデータを作成する関数です。
説明
wp_generate_attachment_metadata() は、画像の各サイズを生成し、メタデータを作成する関数です。
基本構文
wp_generate_attachment_metadata( int $attachment_id, string $file ): array
引数
$attachment_id:添付ファイルのID$file:ファイルのパス
戻り値
メタデータの配列。
使い方(サンプル)
require_once ABSPATH . 'wp-admin/includes/image.php';
$data = wp_generate_attachment_metadata( 45, get_attached_file( 45 ) );
注意点
wp-admin/includes/image.phpの読み込みが必要です。- 画像の再生成に時間がかかるため、大量に実行する場合は分割します。
実務での使いどころ
- プログラムで取り込んだ画像の、サムネイル(各サイズ)を、生成するとき。
- 画像のサイズを追加したあとに、既存の画像のサムネイルを、作り直すとき。
よくあるミスと対策
- メタデータを返すだけで、保存はされない。保存するには、
wp_update_attachment_metadata()を呼ぶ。 - フロント側の処理で、管理画面用のファイル(
wp-admin/includes/image.php)を読み込んでいない。関数が未定義になる。 - 画像の処理は重い。大量の画像を、一度に処理しない。
NG例
$meta = wp_generate_attachment_metadata( $id, $file ); // 保存していない
OK例
require_once ABSPATH . 'wp-admin/includes/image.php';
$meta = wp_generate_attachment_metadata( $id, $file );
wp_update_attachment_metadata( $id, $meta );
使い分け早見表
| 関数 | 役割 |
|---|---|
wp_generate_attachment_metadata() |
サムネイルを生成し、メタデータを返す(保存はしない) |
wp_update_attachment_metadata() |
メタデータを保存する |
wp_insert_attachment() |
ファイルを、メディアとして登録する |
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_update_attachment_metadata()、wp_insert_attachment()
公式リファレンス:wp_generate_attachment_metadata() | Function | WordPress Developer Resources
本記事は情報提供を目的としています。WordPress本体やテーマ・プラグインのバージョンによって動作が異なる場合があるため、本番環境に反映する前に、必ずテスト環境で動作を確認してください。