wp_trim_excerpt

説明

string wp_trim_excerpt( [ string $text = '' [ , mixed $post = null ] ] )
抜粋を取得する。

パラメータ

  • $text
    抜粋を指定(省略時は'')。
  • $post
    [5.2.0]投稿情報または投稿IDを指定(省略時はnull)。

返り値

抜粋を返す。


注意

パラメータ$textが空の場合、投稿情報の本文からショートコードなどを取り除いた抜粋を wp_trim_words関数を使って生成する。

[5.2.0]パラメータ$postが追加され、任意の投稿情報から抜粋が取得できるようになった。


使用例

  • 現在の投稿情報からその抜粋を取得する。
    <?php $excerpt = wp_trim_excerpt(); ?>
  • 変数$post現在の投稿情報からその抜粋を取得する。
    <?php $excerpt = wp_trim_excerpt( '', $post ); ?>

フィルター

[2.7.0]抜粋を生成する前に'excerpt_length'フィルターを呼び出す。パラメータ$numberには文字数(標準は55)が格納されている。
$excerpt_more = apply_filters( 'excerpt_more', $more_string' ' . '[…]' );
[2.9.0]本文を指定した文字数で切り詰める前に'excerpt_more'フィルターを呼び出す。パラメータ$more_stringには文字数(標準は' ' . '[…]')が格納されている。
$excerpt_more = apply_filters( 'excerpt_more', $more_string );
[2.8.0]抜粋を返す前に'wp_trim_excerpt'フィルターを呼び出す。パラメータ$textには抜粋が、$raw_excerptには本関数が受け取り退避しておいた抜粋が格納されている。
return apply_filters( 'wp_trim_excerpt', $text, $raw_excerpt );

アクション

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

ソースファイル

/wp-includes/formatting.php

最終更新 : 2019年05月09日 09:58



お勧め

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

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

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

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

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

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

管理画面でよく使うスタイルをまとめてみた「メッセージ編」(2019年7月30日 更新)

標準で用意されているスタイルを知っておくことで、独自に用意するスタイルを軽減でき、機能拡張した部分の見た目は違和感が少なくなる。そんな共通要素のスタイルのひとつが「メッセージ」だ。メッセージにはいくつかの意味合いがあり、用途に応じてすぐに使い分けすることになる。今回はそんなメッセージ向けのスタイルをざっくりまとめてみた。