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が追加され、任意の投稿情報から抜粋が取得できるようになった。

[6.3.0]抜粋からfootnotesマークアップを除外するようになった。


使用例

  • 現在の投稿情報からその抜粋を取得する。
    <?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

最終更新 : 2023年08月09日 08:07



お勧め

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。

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

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

4.2で始まるiOSの絵文字ケア(2018年5月27日 更新)

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている(基本的にはiOSの)絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。(2024年11月13日 更新)

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア(Clear Unknown Formatting)」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。