wp_trim_words

説明

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

パラメータ

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

返り値

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

注意

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

使用例

  • 文字列の長さを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

最終更新 : 2019年05月09日 10:01



お勧め

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

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

今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)

少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。