説明
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
お勧め
Login rebuilder:プラグイン作ってみました(2024年11月7日 更新)
昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加。2.2.0では管理者のログイン時にメールで通知する機能を追加しました。管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 更新)
クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。カスタムフィールド関連関数のおさらい(2012年6月22日 更新)
カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)
この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。
ブロックエディターで現在の「ロケール」を取得した時のメモ(2024年8月10日 更新)
ブロックエディター向けのプラグインで日本語固有の機能を実装する際、現在のロケール(言語)を取得したい。ブロックエディターの編集時、投稿を編集しているユーザーの言語が優先され、それをどうやって取得するかを「ChatGPT」に聞いてみたのだが。。。