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



お勧め

ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)

管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。

headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)

標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。
<meta name="generator" content="WordPress 3.0.5" />

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

投稿内容に応じてwpautopを制御する(2013年8月13日 更新)

投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。