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

説明

必要に応じて投稿から抜粋を生成する関数。

抜粋の文字数は55単語であり、それを超えるものは' [...]'が付加される。もし文字数が55単語以下であった場合はそのまま表示される。

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

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

使い方

<?php wp_trim_excerpt( $text ) ?>

パラメータ

$text

（文字列） （必須） 抜粋の文字列。もし抜粋が空に設定されていた場合は生成される。抜粋にテキストが入っていた場合はそのまま返される。その場合は短縮されない。

The excerpt. If set to empty an excerpt is generated. If you supply text it will be returned untouched. It will not be shortened.

初期値： なし

戻り値

(string) 

抜粋の文字列。

用例

Notes

• get_the_content を使用します。
• strip_shortcodes() を $text に使用します。
• apply_filters() を 'the_content' の $text に使用します。
• apply_filters() を 'excerpt_length' の 55 に使用します。
• apply_filters() を 'excerpt_more' の '[...]' に使用します。

変更履歴

• 1.5.0にて導入されました。
• 2.8 にて 'excerpt_length' フィルターが追加されました。
• 2.9 にて 'excerpt_more' フィルターが追加されました。 (Ticket 10395)

ソースファイル

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

関連資料

the_excerpt_rss

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

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