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



お勧め

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

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

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。