関数リファレンス/wp trim excerpt

説明

必要に応じて投稿から抜粋を生成する関数です。ループの中で使ってください。

抜粋の長さは 55 単語までになり、それより長い場合は '[...]' が付加されます。もし 55 単語以下であった場合はそのまま返されます。

注: 日本語のように語句の間を半角スペースで区切らない言語では「55単語」を判定できないため、抜粋できずに本文のほとんどが出力されてしまうことがあります。

WordPress 日本語版では、この問題を含むマルチバイト関連の問題に対処するために WP Multibyte Patch プラグインを同梱しています。このプラグインを使用すると、110文字まで（設定により変更可）を抜粋文として出力できます。

使い方

<?php wp_trim_excerpt( $text ); ?>

パラメータ

$text

（文字列） （オプション） 抜粋の文字列。空文字列を与えると抜粋が生成されます。テキストを与えるとそれがそのまま返される他、短縮されません。

初期値： "" — 空文字列

戻り値

(文字列) 

抜粋の文字列。

用例

参考

• get_the_content() を使用します。
• strip_shortcodes()/en を $text に適用します。
• 'the_content' フィルターを $text に適用します。
• 'excerpt_length'/en フィルターを 55 に適用します。
• 'excerpt_more'/en フィルターを '[...]' に適用します。

変更履歴

• 1.5.0 : 新規導入。
• 2.8 : 'excerpt_length'/en フィルターが追加されました。
• 2.9 : 'excerpt_more'/en フィルターが追加されました。（Trac チケット 10395 を参照。）

ソースファイル

wp_trim_excerpt() は wp-includes/formatting.php にあります。

関連資料

the_excerpt_rss(), wp_trim_words()

関数リファレンス、テンプレートタグ目次もご覧ください。

最新英語版： WordPress Codex » Function Reference/wp_trim_excerpt （最新版との差分）