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


お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。