register_rest_field

説明

void register_rest_field( string | string[] $object_type, string $attribute [ , array $args = array() ] )
REST APIリクエスト時、WordPressオブジェクトに対してフィールドを追加する。

パラメータ

  • $object_type
    オブジェクトタイプ名('post'、'term'、'comment'など)またはその配列を指定。
  • $attribute
    属性名を指定。
  • $args
    コールバック関数などを示す連想配列を指定(省略時はarray())。
    キー内容デフォルト値
    get_callbackフィールド取得時のコールバック関数null
    update_callbackフィールド更新時のコールバック関数null
    schemaフィールドのスキーマnull

返り値

返り値はありません。

注意

REST API向けに投稿情報などのWordPressオブジェクトに対して任意のフィールドを追加(拡張)する。

本関数はrest_api_initアクションのコールバック関数内で使用する。


使用例

  • 投稿オブジェクトに'thumbnail_url'を追加する
    register_rest_field( 'post', 'thumbnail_url', array( 'get_callback' => 'myplugin_get_post_thumbnail_url' ) );
    
    function myplugin_get_post_thumbnail_url( $post ) {
    	return get_the_post_thumbnail_url( $post );
    }
    

フィルター

直接実行するフィルターはありません。

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/rest-api.php

最終更新 : 2024年05月17日 08:53


お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。