当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/wp trim excerpt」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(和訳完了。)
 
(en:Function Reference/wp trim excerpt 15:28, 6 March 2015 Bcworkz 版を反映。)
 
(他の1人の利用者による、間の1版が非表示)
2行目: 2行目:
 
== 説明 ==
 
== 説明 ==
 
</div>
 
</div>
必要に応じて投稿から抜粋を生成する関数。
+
必要に応じて投稿から抜粋を生成する関数です。[[ループ]]の中で使ってください。
  
抜粋の文字数は55単語であり、それを超えるものは'<tt> [...]</tt>'が付加される。もし文字数が55単語以下であった場合はそのまま表示される。
+
抜粋の長さは 55 単語までになり、それより長い場合は '<tt>[...]</tt>' が付加されます。もし 55 単語以下であった場合はそのまま返されます。
  
 
<div id="note" class="important">
 
<div id="note" class="important">
(注) 日本語のように語句の間を半角スペースで区切らない言語では「55'''単語'''」を判定できないため、抜粋できずに本文のほとんどが出力されてしまうことがあります。
+
'''注:''' 日本語のように語句の間を半角スペースで区切らない言語では「55'''単語'''」を判定できないため、抜粋できずに本文のほとんどが出力されてしまうことがあります。
  
 
[[日本語で WordPress#WordPress 日本語版|WordPress 日本語版]]では、この問題を含む[[日本語・マルチバイト特有の問題|マルチバイト関連の問題]]に対処するために [http://eastcoder.com/code/wp-multibyte-patch WP Multibyte Patch] プラグインを同梱しています。このプラグインを使用すると、110'''文字'''まで(設定により変更可)を抜粋文として出力できます。
 
[[日本語で WordPress#WordPress 日本語版|WordPress 日本語版]]では、この問題を含む[[日本語・マルチバイト特有の問題|マルチバイト関連の問題]]に対処するために [http://eastcoder.com/code/wp-multibyte-patch WP Multibyte Patch] プラグインを同梱しています。このプラグインを使用すると、110'''文字'''まで(設定により変更可)を抜粋文として出力できます。
15行目: 15行目:
 
== 使い方 ==
 
== 使い方 ==
 
</div>
 
</div>
  <?php wp_trim_excerpt( $text ) ?>
+
  <?php wp_trim_excerpt( $text ); ?>
  
 
<div id="Parameters">
 
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
 
</div>
 
</div>
{{Parameter|$text|文字列|抜粋の文字列。もし抜粋が空に設定されていた場合は生成される。抜粋にテキストが入っていた場合はそのまま返される。その場合は<strong>短縮されない</strong>。
+
{{Parameter|$text|文字列|抜粋の文字列。空文字列を与えると抜粋が生成されます。テキストを与えるとそれがそのまま返される他、<strong>短縮されません</strong>。|オプション|"" &mdash; 空文字列}}
The excerpt. If set to empty an excerpt is generated. If you supply text it will be returned untouched. It will <strong>not</strong> be shortened.}}
+
  
 
<div id="Return_value">
 
<div id="Return_value">
 
== 戻り値 ==
 
== 戻り値 ==
 
</div>
 
</div>
; <tt>(string)</tt> : 抜粋の文字列。
+
; <tt>(文字列)</tt> : 抜粋の文字列。
  
 
<div id="Examples">
 
<div id="Examples">
32行目: 31行目:
 
</div>
 
</div>
  
 
+
<div id="Notes">
== Notes ==
+
== 参考 ==
* [[Function_Reference/get_the_content|<tt>get_the_content</tt>]] を使用します。
+
</div>
* [[Function_Reference/strip_shortcodes|<tt>strip_shortcodes()</tt>]] を <tt>$text</tt> に使用します。
+
* [[関数リファレンス/get_the_content|<tt>get_the_content()</tt>]] を使用します。
* [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] を '<tt>the_content</tt>' <tt>$text</tt> に使用します。
+
* [[関数リファレンス/strip_shortcodes|<tt>strip_shortcodes()</tt>]]/[[:en:Function_Reference/strip_shortcodes|en]] を <tt>$text</tt> に適用します。
* [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] を '<tt>[[Plugin API/Filter Reference/excerpt length|excerpt_length]]</tt>' の <tt>55</tt> に使用します。
+
* '<tt>the_content</tt>' フィルターを <tt>$text</tt> に適用します。
* [[Function_Reference/apply_filters|<tt>apply_filters()</tt>]] を '<tt>[[Plugin API/Filter Reference/excerpt more|excerpt_more]]</tt>' の '<tt>[...]</tt>' に使用します。
+
* '<tt>[[プラグイン API/フィルターフック一覧/excerpt length|excerpt_length]]</tt>'/[[:en:Plugin API/Filter Reference/excerpt length|en]] フィルターを <tt>55</tt> に適用します。
 +
* '<tt>[[プラグイン API/フィルターフック一覧/excerpt more|excerpt_more]]</tt>'/[[:en:Plugin API/Filter Reference/excerpt more|en]] フィルターを '<tt>[...]</tt>' に適用します。
  
 
<div id="Change_log">
 
<div id="Change_log">
 
== 変更履歴 ==
 
== 変更履歴 ==
 
</div>
 
</div>
* 1.5.0にて導入されました。
+
* 1.5.0 : 新規導入。
* [[Version 2.8|2.8]] にて '<tt>[[Plugin API/Filter Reference/excerpt length|excerpt_length]]</tt>' フィルターが追加されました。
+
* [[Version 2.8|2.8]] : '<tt>[[プラグイン API/フィルターフック一覧/excerpt length|excerpt_length]]</tt>'/[[:en:Plugin API/Filter Reference/excerpt length|en]] フィルターが追加されました。
* [[Version 2.9|2.9]] にて '<tt>[[Plugin API/Filter Reference/excerpt more|excerpt_more]]</tt>' フィルターが追加されました。 ([https://core.trac.wordpress.org/ticket/10395 Ticket 10395])
+
* [[Version 2.9|2.9]] : '<tt>[[プラグイン API/フィルターフック一覧/excerpt more|excerpt_more]]</tt>'/[[:en:Plugin API/Filter Reference/excerpt more|en]] フィルターが追加されました。(Trac [https://core.trac.wordpress.org/ticket/10395 チケット 10395] を参照。)
  
 
<div id="Source_file">
 
<div id="Source_file">
 
== ソースファイル ==
 
== ソースファイル ==
 
</div>
 
</div>
<!-- Need links to current source code files -->
 
 
<tt>wp_trim_excerpt()</tt> は {{Trac|wp-includes/formatting.php}} にあります。
 
<tt>wp_trim_excerpt()</tt> は {{Trac|wp-includes/formatting.php}} にあります。
  
56行目: 55行目:
 
== 関連資料 ==
 
== 関連資料 ==
 
</div>
 
</div>
[[Function_Reference/the_excerpt_rss|the_excerpt_rss]]
+
[[テンプレートタグ/the_excerpt_rss|the_excerpt_rss()]],
 +
[[関数リファレンス/wp_trim_words|wp_trim_words()]]
 +
 
 
{{Tag Footer}}
 
{{Tag Footer}}
  
{{原文|Function Reference/wp trim excerpt|132913}}<!-- 09:59, 7 July 2013 Djkaz  -->
+
{{原文|Function Reference/wp_trim_excerpt|149931}} <!-- 15:28, 6 March 2015 Bcworkz 版 -->
 +
 
 +
{{DEFAULTSORT:Wp_trim_excerpt}}
 +
[[Category:関数]]
  
[[Category:Functions]]
+
[[en:Function Reference/wp trim excerpt]]
[[Category:New_page_created]]
+

2015年5月24日 (日) 23:39時点における最新版

必要に応じて投稿から抜粋を生成する関数です。ループの中で使ってください。

抜粋の長さは 55 単語までになり、それより長い場合は '[...]' が付加されます。もし 55 単語以下であった場合はそのまま返されます。

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

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

使い方

<?php wp_trim_excerpt( $text ); ?>

パラメータ

$text
文字列) (オプション) 抜粋の文字列。空文字列を与えると抜粋が生成されます。テキストを与えるとそれがそのまま返される他、短縮されません
初期値: "" — 空文字列

戻り値

(文字列) 
抜粋の文字列。

用例

参考

変更履歴

ソースファイル

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

the_excerpt_rss(), wp_trim_words()


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


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