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


お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。