説明
mixed get_oembed_response_data( mixed $post, int $width )
oEmbedレスポンス情報を取得する。
パラメータ
- $post投稿情報（オブジェクト）または投稿IDを指定。
- $widthリクエストされた幅を指定。
返り値
投稿情報が公開済みの場合はoEmbedレスポンス情報として連想配列を返す。投稿情報が無効か、公開されていない場合はfalseを返す。| キー | 内容 | 有無 |
|---|---|---|
| 'version' | バージョン番号（'1.0'） | 〇 |
| 'provider_name' | サイト名 | 〇 |
| 'provider_url' | サイトのホームURL | 〇 |
| 'author_name' | 投稿者名（display_name） | 〇 |
| 'author_url' | 投稿者アーカイブURL | 〇 |
| 'title' | 投稿タイトル | 〇 |
| 'type' | レスポンスタイプ（'rich'、'link'、'video'など） | 〇 |
| 'width' | 幅 | 〇 |
| 'height' | 高さ | 〇 |
| 'html' | 出力用のHTML | 〇 |
| 'thumbnail_url' | サムネイル画像のURL | 設定時のみ |
| 'thumbnail_width' | サムネイル画像の幅 | 設定時のみ |
| 'thumbnail_height' | サムネイル画像の高さ | 設定時のみ |
注意
投稿者情報が取得できなかった場合、キー'author_name'にはサイト名が、'author_url'にはサイトのホームURLが格納される。
幅の値は標準（'oembed_min_max_width'フィルターで変更可能）で200～600の範囲となり、高さは幅の16:9の比率で算出された値（200未満の場合は200）となる。
キー'html'以降の内容は、標準で'oembed_response_data'フィルターとして優先度10で指定されているget_oembed_response_data_rich関数によって格納される。キー'thumbnail_url'、'thumbnail_width'、'thumbnail_height'は投稿情報にサムネイル画像が設定されている場合のみとなる。
使用例
- oEmbedレスポンス情報を取得する。<?php wp_check_for_changed_dates( $post, 600 ); ?>
フィルター
[4.4.0]幅と高さを決定する前に'oembed_min_max_width'フィルターを呼び出す。パラメータには幅の上限と下限を含んだ連想配列が格納される。$min_max_width = apply_filters( 'oembed_min_max_width', array(
'min' => 200,
'max' => 600
) );return apply_filters( 'oembed_response_data', $data, $post, $width, $height );アクション
実行するアクションはありません。ソースファイル
/wp-includes/embed.php最終更新 : 2018年12月07日 10:02
関連
お勧め
テーブルブロックを定形に整える（2021年12月27日 更新）
ブロックエディターについて調べていると、「段落ブロックをもう少しカスタマイズした」で使ったRichTextShortcutとは別にショートカットキーを使うためのKeyboardShortcutsが見つかった。今回はこのKeyboardShortcutsを使ってテーブルブロックを定形に整える仕組みを考えてみた。
各種リンクを取得する関数一覧（2014年6月12日 更新）
サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク（パーマリンク）を取得する関数を用意しており、それらを一通り把握しておくべきだろう。
スクリプトファイルのバージョンパラメータを変更する（2018年5月27日 更新）
Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。
4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する（2018年5月27日 更新）
ダッシュボードの「アクティビティ」ウィジェットは「投稿（post）」の状況を表示し、固定ページ（page）やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。
投稿一覧に「投稿フォーマット」フィルターが追加される（2019年4月12日 更新）
WordPress 5.2 Beta2（以降5.2Beta2）のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」（select要素）が追加されていた。