wp_trim_excerpt

（1.5.0以降）
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

関連

参考

Code Reference: wp_trim_excerpt

お勧め

WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI#2（2018年5月27日 更新）

今回は「前回」の続き。さくらのVPS（メモリー2GB SSDプラン）でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

タイトルのみをキーワード検索する（2014年4月3日 更新）

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

Login rebuilder 2.6.0の新機能紹介（2019年4月22日 更新）

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

Blacklist keys manager：プラグイン作ってみました（2015年5月22日 更新）

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。