説明
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最終更新 : 2024年02月29日 08:34
関連
お勧め
プラグインのロード順を制御する（2014年6月9日 更新）
これまでプラグインがどのような順番でロードされるか意識していなかったのだが、とある自作プラグインを他のプラグインよりも先にロードさせたくなったので調べてみた。
5.3の機能強化：カスタムフィールドキーの条件指定が使いやすくなる（2019年11月19日 更新）
5.3 RC4もリリースされ、正式リリースまであと1週間。5.3の変更点を確認していると、WP_Meta_Queryクラスが変更されていた。これは「Expanded meta key comparison operators in 5.3」で紹介されており、さまざまな条件指定が追加されていた。
HTML entities button：プラグイン作ってみました（2021年4月28日 更新）
以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。更新ボタンの横にスピナーを実装する（2019年5月14日 更新）
WordPressの管理画面ではAJAXを使って何らかの処理を行う際、数秒間の空き時間にアイコンがクルクル回る「スピナー」を表示しているところがある。今作っているプラグインでこの「スピナー」を使いたくなったので、実装方法を調べてみた。
「順序」をtextからnumberに変更してみた（2018年5月27日 更新）
固定ページの編集画面の「投稿の属性」ウィジェットには、ページの並び替えに使用できる「順序」のinput要素がある。この「順序」のinput要素はtype属性が'text'となっており、編集の際にIMEが有効になってしまう場合がある。ページの編集頻度が多くなると、その都度IMEをオフにするのがやや面倒になってくる。