説明
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
関連
お勧め
スマートフォン向けの振り分けを自前で行う(2012年1月23日 更新)
PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)
固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。
適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす(2019年5月24日 更新)
/wp-includes/template-loader.phpではリクエストされたページに応じて現在のテーマにあるテンプレートファイルの中から適切なものを選びに振り分けている。ここでは、さまざまなテンプレートファイルの種類と、テンプレートファイルが省略された場合の内部の動作についてまとめてみる。管理者ページに文言を表示する(2012年4月19日 更新)
お客様向けに管理者ページをカスタマイズする機会が増えてきている。カスタマイズするページや表示場所、表示内容によっていくつかの手段があるが、今回はページの冒頭部分に任意の文言を表示する方法を紹介する。5.3の機能強化:ユーザーパスワードの表示と非表示(2019年9月30日 更新)
「WordPress 5.3 Beta 1」に記載されていた「Toggle password view」という項目。「Other Changes for Developers」の見出しの中ということもあり、ちょっと調べてみた。