概要
wp_trim_words 関数は、文字列を指定の長さに揃えるために使用される WordPress の関数です。この関数は、投稿やカスタムテキストの要約を作成する際に便利です。具体的には、以下のような機能を実装する際によく使われます。
1. 投稿のサマリー表示
2. ウィジェットでのテキスト制限
3. SEO対策のためのメタディスクリプション作成
4. コメントの要約表示
5. 検索結果の抜粋表示
6. ページネーションのテキスト制限
7. カスタム投稿タイプでのテキスト整理
8. APIレスポンスのデータ整理
構文
wp_trim_words( $text, $num_words, $more );
パラメータ
$text(string): 処理する元の文字列。$num_words(int): 許可される単語の数。$more(string): 文字列の末尾に追加するテキスト。デフォルトは「…」。
戻り値
- (string): 指定した単語数に制限された文字列。
関連する関数
使用可能なバージョン
- 2.9.0 以降で使用可能です。
コアファイルのパス
/wp-includes/general-template.php
サンプルコード
サンプルコード 1: 基本的な使用法
$text = 'これはテストの文字列です。WordPressは素晴らしいCMSです。';
$trimmed_text = wp_trim_words($text, 5);
echo $trimmed_text; // これはテストの文字列です。WordPressは...
このコードは、指定した文字列を5つの単語に制限し、末尾に「…」を追加して表示します。
サンプルコード 2: 読みやすい要約の作成
$post_content = 'WordPressはブログやウェブサイトを作成するための非常に強力なツールです。多くの機能が用意されていて、ユーザーにとって使いやすいです。';
$summary = wp_trim_words($post_content, 10, '...');
echo $summary; // WordPressはブログやウェブサイトを作成するための...
このサンプルは、投稿内容から10単語以内の要約を作成します。
サンプルコード 3: ウィジェットでの使用
function custom_widget_content() {
$content = 'ウィジェットに表示する長いテキストがここにあります。テキストはくり返しが多く、短くする必要があります。';
echo wp_trim_words($content, 8, '...');
}
この関数はカスタムウィジェットで使用され、テキストを8単語に制限します。
サンプルコード 4: API レスポンスでの利用
function api_response() {
$long_text = 'このテキストは非常に長いので、APIレスポンスに含まれる場合には短縮する必要があります。';
return wp_trim_words($long_text, 6, '...');
}
APIからのレスポンスに短縮されたテキストを提供します。
サンプルコード 5: 投稿の抜粋作成
function get_post_excerpt($post_id) {
$post = get_post($post_id);
return wp_trim_words($post->post_content, 15, '...');
}
指定した投稿の内容から15単語に縮めた抜粋を取得します。
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | |
| get_header | |
| wp_head |
wp_trim_words 関数が特定の WordPress バージョンで非推奨または削除された場合のバージョンはありません。