WordPress.org

Languages: English • 関数リファレンス/wp trim excerpt 日本語 (Add your language)

Description

Generates an excerpt from the content, if needed. Must be used inside the "Loop".

The excerpt word amount will be 55 words and if the amount is greater than that, then the string ' […]' will be appended to the excerpt. If the string is less than 55 words, then the content will be returned as is.

Usage

<?php wp_trim_excerpt( $text ) ?>

Parameters

$text

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

Default: ""(empty string)

Return Values

(string) 

The excerpt.

Examples

Notes

• Uses: get_the_content
• Uses: strip_shortcodes() on $text.
• Uses: apply_filters() for 'the_content' on $text.
• Uses: apply_filters() for 'excerpt_length' on 55.
• Uses: apply_filters() for 'excerpt_more' on '[...]'.

Change Log

• Since: 1.5.0
• 2.8 : Added the 'excerpt_length' filter.
• 2.9 : Added the 'excerpt_more' filter. (Ticket 10395)

Source File

wp_trim_excerpt() is located in wp-includes/formatting.php.

Related

the_excerpt_rss, wp_trim_words