wp_trim_words

説明

string wp_trim_words( string $text [ , int $num_words = 55 [ , string $more = null ] ] )
文字列を指定の長さに揃える。

パラメータ

  • $text
    長さを調整する文字列を指定。
  • $num_words
    単語数または文字の長さを指定(省略時は55)。
  • $more
    文字列の長さを調整した際に追加する文字列を指定(省略時はnull)。

返り値

長さを揃えた文字列を返す。

注意

パラメータ$moreが省略された場合、調整時に追加する文字列は'…'となる。

サイトの言語設定に応じて、単語数または文字数によって切り詰める。切り詰め方法を決定する条件は次の通りで、この条件を満たす場合は文字数で切り詰め、条件を満たさない場合は単語数で切り詰める。

if ( strpos( _x( 'words', 'Word count type. Do not translate!' ), 'characters' ) === 0 &&
	preg_match( '/^utf\-?8$/i', get_option( 'blog_charset' ) ) ) {

※日本語環境では _x関数で取得される内容は'characters_including_spaces'となっているため、文字列で切り詰めることになる。


使用例

  • 文字列の長さを50文字で揃える。
    <?php $trim_string = wp_trim_words( $text, 50 ); ?>
  • 文字列の長さを50文字で揃え、超過している場合は'…'を追加する。
    <?php $trim_string = wp_trim_words( $text, 50, '…' ); ?>

フィルター

調整した文字列を返す直前にwp_trim_wordsフィルターを呼び出す。パラメータ$textには調整後の文字列が渡る。
return apply_filters( 'wp_trim_words', $text, $num_words, $more, $original_text );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/formatting.php

最終更新 : 2020年04月28日 12:26



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう(2011年12月8日 更新)

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

5.3の新機能:日付とタイムゾーン(2019年10月2日 更新)

WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

Login rebuilderのログ表示機能を紹介(2018年5月27日 更新)

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

さくらのVPSでKUSANAGI#3(2018年5月27日 更新)

今回は「前回」の続き。http(80番)をクローズ、そのほかに行った調整作業について整理する。