説明
パラメータ
- $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には調整後の文字列が渡る。アクション
実行するアクションはありません。ソースファイル
/wp-includes/formatting.php最終更新 : 2024年02月29日 08:34
関連
お勧め
ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)
投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。リクエスト応答を終了する前に何かを処理する(2013年9月26日 更新)
PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。
投稿情報を連想配列で参照する(2018年5月27日 更新)
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。
段落ブロックに日付・時刻の入力支援を実装した(2023年1月25日 更新)
ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。
ブロックエディターのタグ入力にタグクラウド機能を追加した(2019年1月10日 更新)
ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。