get_oembed_response_data

説明

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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

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

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

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。