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



お勧め

スクリプトファイルのバージョンパラメータを変更する(2018年5月27日 更新)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

Gutenberg、「新規追加」に難あり(2018年10月25日 更新)

昨日公開した「Gutenberg、初見です」で自作プラグインの「複製」機能が正しく動作していないことについて軽く触れた。該当するプラグインを修正するにしても原因がはっきりしないと手の打ちようがない。そんなわけで、不具合の原因を調べてみた。

「テキスト」モードと「ビジュアル」モードを行き来すると投稿内容の一部が消える(2018年5月27日 更新)

仕事がらサイトの引っ越し作業のお手伝いをすることがあるのですが、今回は引っ越しにあわせてWordPressを「3.7.1」から最新版「4.1.1」にアップデートすることになりました。ここで紹介するのはこの案件で発生したトラブルの話です。