説明
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
関連
お勧め
5.5で非推奨になる関数名について（2020年8月12日 更新）
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2（以降Beta 2）」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
meta_compare_key使ってみた（2019年3月19日 更新）
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。
プラグインの設定ページもレスポンシブ対応（2014年6月3日 更新）
レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。
初期化に関連するアクションのおさらい（2013年11月27日 更新）
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。全投稿を取得するのはnopaging=1でいい（2011年8月31日 更新）
query_posts関数（またはWP_Queryクラス）を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」－「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには？