get_the_excerpt

説明

string get_the_excerpt( [ mixed $post = null$deprecated = '' ] )
投稿情報の抜粋記事を取得する。

パラメータ

  • [4.5.0]$post$deprecated
    投稿IDまたは投稿情報オブジェクトを指定(省略時はnull)未使用(2.3で非推奨)

返り値

抜粋記事の文字列を返す。投稿記事にパスワードが設定されている場合は、'There is no excerpt because this is a protected post.'(もしくはその翻訳テキスト)になる。

注意

[4.5.0]バージョン2.3以降パラメータの使用は非推奨とされてきたが、4.5.0から投稿IDまたは投稿情報オブジェクトを指定できるよう仕様が変更された。なおパラメータが省略された場合は従来通り現在の投稿情報の抜粋を返す。

抜粋記事は'get_the_excerpt'フィルターが適用される。[4.5.0]パラメータ$postで指定された投稿情報が見つからない場合はフィルターを通過せずに''を返す。


使用例

  • 現在の投稿情報の抜粋記事を取得する。
    <?php $excerpt = get_the_excerpt(); ?>

フィルター

[1.2.0]抜粋テキストを返す直前に'get_the_excerpt'フィルターが呼び出す。パラメータ$excerptには抜粋テキストが格納されている。[4.5.0]パラメータ$postには対象の投稿情報オブジェクトが格納されている。
return apply_filters( 'the_excerpt', $excerpt, $post );

アクション

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

ソースファイル

/wp-includes/post-template.php

最終更新 : 2018年05月27日 10:51



お勧め

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

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

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

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

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

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

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

32ピクセルのサイトアイコンを別の画像ファイルに変更する(2018年5月27日 更新)

「サイトアイコン」は4.3の新機能の1つ。管理画面で適当な画像ファイルを指定するだけでサイトアイコンが適用されます。そんなサイトアイコンで、既存の favicon.ico を併用する方法を紹介します。