get_the_excerpt

(0.71以降)
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

関連

  • the_excerpt - 投稿情報の抜粋記事を表示する
  • the_excerpt_rss - RSSフィード用の抜粋記事を出力する
  • the_post - 投稿データをロードする

お勧めコンテンツ

PHPとMySQLのバージョンを確認(2013年9月11日 登録)

先日、WordPressで構築されたサイトについて最新版へのバージョンアップを依頼される。使用されていたWordPressはバージョン2.xということで、最新版へバージョンアップできるのか、PHPとMySQLのバージョンを確認することになった。

CSSやJavaScriptファイルのバージョン番号を変える(2017年3月14日 登録)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

もうquery_postsは呼ばない(2011年9月27日 登録)

トップページやカテゴリーページで標準の条件に少し手を加えた投稿情報を表示するケースがある。そんな時、テンプレートファイルの先頭でquery_posts関数を呼び出して投稿情報を再抽出していたのだが、フィルター処理をうまく使えばquery_posts関数を呼び出さなくても大丈夫みたいだ。

headタグのmeta(generator)タグを取り除く(2011年2月18日 登録)

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

リクエスト応答を終了する前に何かを処理する(2013年9月26日 登録)

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

最終更新日時 : 2016-05-23 12:49