説明
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
- $fire_after_hooks
返り値
正しく登録できた場合は投稿情報の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.9.0]更新する投稿情報の再構築後、投稿タイプが'attachment'の場合は'wp_insert_attachment_data'フィルターを呼び出す。パラメータ$dataには再構築された投稿情報が、$postarrには本関数が受け取った内容にデフォルト要素を補完後にサニタイズしたものが格納されている。[5.4.1]パラメータ$unsanitized_postarrが追加され、本関数が受け取り時の$postarrの内容が格納されている。[6.0.0]パラメータ$updateが追加され、投稿済み($postarr['ID']が空でない)の場合はtrueが格納されている。$data = apply_filters( 'wp_insert_attachment_data', $data, $postarr, $unsanitized_postarr, $update );
$data = apply_filters( 'wp_insert_post_data', $data, $postarr, $unsanitized_postarr, $update );
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最終更新 : 2022年06月01日 12:29
関連
お勧め
6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)
バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。
固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)
固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。
Fotepo:プラグイン作ってみました(2019年9月19日 更新)
仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。