wp_insert_attachment

（2.0.0以降）
wp_insert_attachment - メディア（添付ファイル）を登録する

説明

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

関連

参考

Code Reference: wp_insert_attachment

お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた（2019年11月5日 更新）

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta（generator）タグを取り除く（2018年5月27日 更新）

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。 
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager：プラグイン作ってみました（2015年5月22日 更新）

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

5.5の機能強化：テーマ変更時に要求バージョンを確認（2020年8月12日 更新）

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2（以降RC 2）」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

投稿内容に応じてwpautopを制御する（2013年8月13日 更新）

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。