register_rest_field

（4.7.0以降）
register_rest_field - REST APIリクエスト時、WordPressオブジェクトに対してフィールドを追加する

説明

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

参考

Code Reference: register_rest_field

お勧め

プラグインのロード順を制御する（2014年6月9日 更新）

これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。

5.3の機能強化：カスタムフィールドキーの条件指定が使いやすくなる（2019年11月19日 更新）

5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

更新ボタンの横にスピナーを実装する（2019年5月14日 更新）

WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。

「順序」をtextからnumberに変更してみた（2018年5月27日 更新）

固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。