説明
パラメータ
- $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
関連
お勧め
個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)
先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。
決まった値を返すだけの関数群(2018年5月27日 更新)
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)
ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)
Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。
favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)
先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。