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



お勧め

Login rebuilderに「XML-RPC設定」を追加しました(2018年5月27日 更新)

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

5.7の新機能:HTTPからHTTPSへの移行(2021年3月13日 更新)

先週は「WordPress 5.7 Beta 2(以降Beta 2)」が公開され、正式版リリースへ一歩進みました。WordPress 5.7の注目ポイントの1つに「HTTPからHTTPSへの移行」を手助けする機能があり、それに関連する機能を含んだhttps-detection.phpファイルとhttps-migration.phpが追加されていた。

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

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