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



お勧め

自動生成される抜粋からテーブルブロックの内容を除外する(2022年4月6日 更新)

標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。

Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)

みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。

さくらのVPSでKUSANAGI#2(2018年5月27日 更新)

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。