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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。

ツイート引用が簡単になる仕組み(2012年6月8日 更新)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

検索ワード「-10,000円」を検索できるようにしたい(2018年5月27日 更新)

とあるサイトで「-10,000円」をキーワードに検索した際、予想と異なるページが表示され、ちょっと驚いた。今回はその原因調査と対策についてまとめてみた。

32ピクセルのサイトアイコンを別の画像ファイルに変更する(2018年5月27日 更新)

「サイトアイコン」は4.3の新機能の1つ。管理画面で適当な画像ファイルを指定するだけでサイトアイコンが適用されます。そんなサイトアイコンで、既存の favicon.ico を併用する方法を紹介します。