get_oembed_response_data

（4.4.0以降）
get_oembed_response_data - oEmbedレスポンス情報を取得する

説明

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
) );
[4.4.0]値を返す直前で'oembed_response_data'フィルターを呼び出す。パラメータ$dataには連想配列が、$postには投稿情報が、$widthには幅が、$heightには高さが格納される。 
return apply_filters( 'oembed_response_data', $data, $post, $width, $height );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/embed.php

最終更新 : 2018年12月07日 10:02

関連

参考

Code Reference: get_oembed_response_data

お勧め

管理画面でツールバー（Admin bar）を非表示にする（2013年3月5日 更新）

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

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

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

タイトルが一致する投稿を検索する（2014年2月20日 更新）

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数（WP_Queryクラス）が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数（WP_Queryクラス）の使用法の一例である。

投稿ページでユニークなテンプレートを選択しよう（2018年5月27日 更新）

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ（'page'）向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ（'post'）はもちろんカスタム投稿タイプのページにも適用可能になっている。

WordPressの鼓動（2013年10月1日 更新）

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。