• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/wp trim words

提供: WordPress Codex 日本語版
移動先: 案内検索

この関数は、テキストの先頭から指定された数の単語を切り出し、切り出した文字列を返します。

注: 日本語のように語句の間を半角スペースで区切らない言語では「55単語」を判定できないため、抜粋できずに本文のほとんどが出力されてしまうことがあります。

WordPress 日本語版では、この問題を含むマルチバイト関連の問題に対処するために WP Multibyte Patch プラグインを同梱しています。このプラグインを使用すると、110文字まで(設定により変更可)を抜粋文として出力できます。

使い方

<?php $trimmed = wp_trim_words( $text, $num_words, $more ); ?>

パラメータ

$text
文字列) (必須) 切り出す前の文字列。
初期値: なし
$num_words
整数) (オプション) 単語数(WP Multibyte Patch 有効時は文字数)
初期値: 55(WP Multibyte Patch 有効時は 110)
$more
文字列) (オプション$text を切り落とす必要がある場合に付加する文字列。
初期値: '&hellip;'

戻り値

(文字列) 
切り出された文字列。

用例

基本的な例です。これはフォーマット指定の除去も行います。

<?php
echo wp_trim_words( get_the_content(), 40, '...' );
?>

変更履歴

  • 3.3.0 : 新規導入

ソースファイル

wp_trim_words()wp-includes/formatting.php にあります。

WordPress における wp_trim_words の使い方(英文)


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/wp_trim_words最新版との差分