説明
mixed wp_insert_post( array $postarr [ , bool $wp_error = false [ , bool $fire_after_hooks = true ] ] )
投稿情報を登録する。
パラメータ
- $postarr投稿情報を連想配列で指定。連想配列の内容(抜粋)は次の通り。
キー名 省略時の値 内容 'post_status' 'draft' 投稿ステータス('draft'、'publish'、'private'、'future'など) 'post_type' 'post' 投稿タイプ('post'、'page'、カスタム投稿タイプ名など) 'post_author' $user_ID 投稿者ID 'ping_status' get_option( 'default_ping_status' ) デフォルトのピンステータス 'post_parent' 0 親の投稿情報ID 'menu_order' 0 メニューの表示順 'to_ping' '' 'pinged' '' 'post_password' '' パスワードによるアクセス制限時のパスワード 'guid' '' 'post_content_filtered' '' 'post_excerpt' '' 抜粋 'import_id' 0 新しい投稿情報ID(未使用のID) 'post_content' '' 投稿記事 'post_title' '' タイトル 'ID' ― 投稿情報ID 'post_category' ― カテゴリーIDの配列 'tags_input' ― 投稿タグの文字列(複数の場合は,(カンマ)区切り) 'comment_status' ― コメントステータス('open'、'closed'など) 'post_date' ― 投稿日時 - $wp_error登録失敗時にエラー内容を示す WP_Errorオブジェクトを返す場合はtrueを、0を返す場合はfalseを指定(省略時はfalse)
- $fire_after_hooks[5.6.0]投稿情報とその関連情報の保存後に wp_after_insert_post関数を呼び出す場合はtrueを指定(省略時はtrue)。
返り値
正しく登録できた場合は投稿情報のIDを返す。登録できなかった場合は、パラメータ$wp_errorにしたがってWP_Errorオブジェクトまたは0を返す。注意
'ID'プロパティで指定した投稿情報がすでに存在する場合は、追加は行わず、その投稿情報を更新する。なお、公開済みの投稿危記事を'post_status'プロパティを省略して更新すると、ステータスが「下書き('draft')」などに変わってしまう。また固定ページを'post_type'プロパティを省略して更新すると、投稿タイプが「投稿('post')」に変わってしまう。どちらも注意が必要だ。'post_status'プロパティが'private'以外の場合、'post_password'プロパティを指定しても無効となる。
'post_type'プロパティが'post'で'post_status'プロパティが'auto-draft'以外の場合、'post_category'プロパティが省略されている場合はデフォルトのカテゴリーが適用される。
内部では、デフォルトのカテゴリーID、コメントステータス(「新しい投稿へのコメントを許可する」の値)、ピンステータス(「他のブログからの通知 (ピンバック・トラックバック) を受け付ける」の値)を取得している。
$post_category = array( get_option('default_category') );
$comment_status = get_option( 'default_comment_status' );
$ping_status = get_option( 'default_ping_status' );
使用例
- 投稿情報としてタイトルと内容を登録する。<?php $post_id = wp_insert_post( array( 'post_title'=>'テスト投稿', 'post_content'=>'この投稿はテストです。' ) ); ?>
- 投稿情報として$postarrを登録する。登録できなかった場合はエラー内容を取得する。<?php $post_id = wp_insert_post( $postarr, true ); ?>
フィルター
[3.3.0]指定された投稿情報が「空」か調べるため'wp_insert_post_empty_content'フィルターを呼び出す。$maybe_emptyにはタイトル、コンテント(記事内容)、抜粋のすべてが空の場合にtrueが格納されている。if ( apply_filters( 'wp_insert_post_empty_content', $maybe_empty, $postarr ) ) {
$post_parent = apply_filters( 'wp_insert_post_parent', $post_parent, $post_ID, compact( array_keys( $postarr ) ), $postarr );
アクション
[2.5.0]投稿情報を更新する前に'pre_post_update'アクションを呼び出す。do_action( 'pre_post_update', $post_ID );
do_action( "edit_post_{$post->post_type}", $post_ID, $post );
do_action( 'edit_post', $post_ID, $post );
do_action( 'post_updated', $post_ID, $post_after, $post_before );
do_action( "save_post_{$post->post_type}", $post_ID, $post, $update );
do_action( 'save_post', $post_ID, $post, $update );
do_action( 'wp_insert_post', $post_ID, $post, $update );
ソースファイル
/wp-includes/post.php最終更新 : 2020年12月12日 16:11
関連
お勧め
ダッシュボードの「クイックドラフト」を「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関数を制御できないか考えてみた。