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 - 投稿データをロードする

お勧めコンテンツ

Contact Form 7に確認フェーズを(2011年12月12日 登録)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

WordPressの鼓動(2013年10月1日 登録)

WordPressでは、Ajaxを利用する方法の1つとしてadd_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 登録)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

プラグインで注意が必要な関数(2013年11月27日 登録)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

Post-tag automaton:プラグイン作ってみました(2012年7月3日 登録)

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

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