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

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

関数リファレンス/wp html excerpt

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

指定された HTML 文字列の先頭から $count 文字までを安全に取り出します。

この関数は、UTF-8、タグ、エンティティーについて矛盾を起こさないように抜粋を取り出します。エンティティー内部は文字数 1 とカウントされません。例えば & は 4、< は 3、などです。

参考: wp_strip_all_tags() により HTML タグ、script タグ、style タグを除去する他、1 つ以上の連続する改行または空白(タブを含む)を半角スペース 1 つに置換します。

使い方

<?php wp_html_excerpt( $str, $count, $more ); ?>

パラメータ

$str
文字列) (必須) 抜粋を取り出す文字列。
初期値: なし
$count
整数) (必須) 取り出す最大文字数。
初期値: なし
$more
文字列) (オプション$str を切り落とす必要がある場合に付加する文字列。null にすると何も付加しません。
初期値: null

戻り値

(文字列) 
抜粋。

用例

<?php

$str = 'There are lots &amp; <strong>lots</strong> of usages for this function. I know you can think of some! (lots more text here)';

echo wp_html_excerpt( $str, 50 );

// 出力: 'There are lots &amp; lots of usages for this funct'

// $more パラメータを使用:
echo wp_html_excerpt( $str, 50, '...' );

// 出力: 'There are lots &amp; lots of usages for this funct...'

?>

参考

変更履歴

2.5.0 : 新規導入

ソースファイル

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

wp_trim_excerpt(), the_excerpt(), get_the_excerpt()


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


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