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'フィルターを呼び出す。パラメータ$excerpt_lengthには文字数(標準は55の翻訳内容(日本語の場合は110))が格納されている。
$excerpt_length = (int) apply_filters( 'excerpt_length', $excerpt_length );
[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年11月22日 10:59



お勧め

パスとURL(2011年10月6日 更新)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。