wp_insert_post

(1.0.0以降)
wp_insert_post - 投稿情報を登録する

説明

mixed wp_insert_post( array $postarr [ , bool $wp_error = false ] )
投稿情報を登録する。

パラメータ

  • $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)

返り値

正しく登録できた場合は投稿情報の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' );
[4.2.0]タイトル(post_titile)、本文(post_content)、抜粋(post_excerpt)については、カラムのcharsetが'utf8'の場合にwp_encode_emoji関数を使って絵文字の文字コードをHTMLエンティティに変換する。

使用例

  • 投稿情報としてタイトルと内容を登録する。
    <?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 ) ) {
[3.1.0]親記事のIDを指定する前に'wp_insert_post_parent'フィルターを呼び出す。
$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 );
[1.2.0]すでに投稿情報が登録されている場合'edit_post'アクションを呼び出す。$postには更新する投稿情報が格納されている。
do_action( 'edit_post', $post_ID, $post );
[3.0.0]すでに投稿情報が登録されている場合'edit_post'アクションの後に'post_updated'アクションを呼び出す。$post_afterには更新後の投稿情報が、$post_beforeには更新前の投稿情報が格納されている。
do_action( 'post_updated', $post_ID, $post_after, $post_before );
[3.7.0]'save_post'アクションを呼び出す前に'save_post_post'のような末尾に投稿タイプ名を含むアクションを呼び出す。$postには更新する投稿情報が格納されている。
do_action( "save_post_{$post->post_type}", $post_ID, $post, $update );
[1.5.0]'save_post'アクションを呼び出す。$postには更新する投稿情報が格納されている。
do_action( 'save_post', $post_ID, $post, $update );
[2.0.0]'wp_insert_post'アクションを呼び出す。$postには更新する投稿情報が格納されている。
do_action( 'wp_insert_post', $post_ID, $post, $update );

ソースファイル

/wp-includes/post.php

関連

お勧めコンテンツ

Login rebuilder 2.3.0の新機能を紹介(2017年8月31日 登録)

プラグイン「Login rebuilder」はログイン時の履歴(ログ)や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。

投稿ページにキーワード検索ウィジェットを追加する(2012年6月2日 登録)

「投稿の編集」ページで記事を編集していると、関連する投稿記事を検索したくなることがある。そんな時、「投稿一覧」ページに戻って「キーワード検索」を行えばいいのだが、そのひと手間がちょっとだけ煩わしい。

投稿記事でrubyタグを使えるようにする(前編)(2012年1月25日 登録)

rubyなどのルビ関連タグはIEの独自サポートから始まり、少し前のChrome/Safariが追随して利用できるようになっている。Firefoxはいまだにサポートしていないのだが、それなりに代替表示されるので、投稿記事で使えるようにしてみた。

時代はWP_Queryなのか(2011年8月1日 登録)

WordPressのテーマ作成において、メインの投稿記事とは別に特定の条件を指定した投稿内容を表示することが多々ある。つい最近までget_posts関数を使用することが多かったのだが、最近はWP_Queryクラスを使用することが多くなってきた。

テキストエディタの文字を変更する(2016年8月30日 登録)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。

最終更新日時 : 2015-04-24 13:58