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

「プラグイン API/フィルターフック一覧/get the excerpt」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(英語版をコピペ)
 
(和訳完了。)
2行目: 2行目:
 
== 説明 ==
 
== 説明 ==
 
</div>
 
</div>
<b>"get_the_excerpt"</b> filter is used to filter the excerpt of the post after it is retrieved from the database and before it is returned from
+
<b>"get_the_excerpt"</b> フィルターは投稿の抜粋がデータベースから読み出され、 <tt>get_the_filter()</tt> 関数から返される前にフィルターするために用いられます。
 
+
The <b>"get_the_excerpt"</b> filter is used to filter the excerpt of the post after it is retrieved from the database and before it is returned from the get_the_filter() function.
+
  
 
<div id="Usage">
 
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 
</div>
 
</div>
When the 'get_the_excerpt' filter is called, it is passed a single argument containing the post excerpt. 
+
'get_the_excerpt' フィルターが呼び出されると、投稿の抜粋を含んだ1つの引数が渡されます。
  
 
<pre>
 
<pre>
18行目: 16行目:
 
</pre>
 
</pre>
  
Where 'filter_function_name' is the function WordPress should call when the excerpt is being retrieved. Note that the filter function <b>must</b> return the excerpt after it is finished processing, or page sections showing an excerpt will be blank, and other plugins also filtering the excerpt may generate errors.
+
'filter_function_name' は抜粋が読み出された時にWordPressが呼び出す関数です。この時フィルター機能は処理が終わった後に抜粋を<b>返さねばなりません</b>。さもなくば、抜粋を表示させるページセクションは空白となり、抜粋をフィルターする他のプラグインがエラーを吐くことにもなります。
  
'''filter_function_name''' should be unique function name. It cannot match any other function name already declared.
+
'''filter_function_name''' はユニークな関数名である必要があります。つまりすでに宣言されている関数名と同じであってはいけません。
  
 
<div id="Examples">
 
<div id="Examples">
29行目: 27行目:
 
=== 「続きを読む」リンクのカスタム化 ===
 
=== 「続きを読む」リンクのカスタム化 ===
 
</div>
 
</div>
This example from the twentyeleven theme appends a custom "Read more" link to post excerpts. See [http://codex.wordpress.org/Function_Reference/has_excerpt has_excerpt()] and [http://codex.wordpress.org/Function_Reference/is_attachment is_attachment()]
+
カスタム化された「続きを読む」リンクを抜粋に追加する例をTwentyelevelのテーマを用いて紹介します。詳しくは、 [[Function_Reference/has_excerpt|has_excerpt()]] と [[Function_Reference/is_attachment|is_attachment()]] を参照してください。
  
 
<pre>
 
<pre>
 
/**
 
/**
  * Adds a pretty "Continue Reading" link to custom post excerpts.
+
  * 読みやすい形の「続きを読む」リンクを投稿の抜粋に追加します。
 
  *
 
  *
  * To override this link in a child theme, remove the filter and add your own
+
  * このリンクを子テーマにも適用させる場合は、フィルターを削除して、
  * function tied to the get_the_excerpt filter hook.
+
  * get_the_excerpt フィルターフックに紐付けられた関数に追加してください。
 
  */
 
  */
 
function twentyeleven_custom_excerpt_more( $output ) {
 
function twentyeleven_custom_excerpt_more( $output ) {
50行目: 48行目:
 
==参考資料==
 
==参考資料==
 
</div>
 
</div>
* [[Plugin_API#Create_a_Filter_Function|Creating a Filter Function]]
+
* [[Plugin_API#Create_a_Filter_Function|フィルター関数の作成]]
 
* [[Function_Reference/add_filter|add_filter()]]
 
* [[Function_Reference/add_filter|add_filter()]]
  

2013年7月7日 (日) 12:45時点における版

"get_the_excerpt" フィルターは投稿の抜粋がデータベースから読み出され、 get_the_filter() 関数から返される前にフィルターするために用いられます。

使い方

'get_the_excerpt' フィルターが呼び出されると、投稿の抜粋を含んだ1つの引数が渡されます。

function filter_function_name( $excerpt ) {
  # ...
}
add_filter( 'get_the_excerpt', 'filter_function_name' );

'filter_function_name' は抜粋が読み出された時にWordPressが呼び出す関数です。この時フィルター機能は処理が終わった後に抜粋を返さねばなりません。さもなくば、抜粋を表示させるページセクションは空白となり、抜粋をフィルターする他のプラグインがエラーを吐くことにもなります。

filter_function_name はユニークな関数名である必要があります。つまりすでに宣言されている関数名と同じであってはいけません。

用例

カスタム化された「続きを読む」リンクを抜粋に追加する例をTwentyelevelのテーマを用いて紹介します。詳しくは、 has_excerpt()is_attachment() を参照してください。

/**
 * 読みやすい形の「続きを読む」リンクを投稿の抜粋に追加します。
 *
 * このリンクを子テーマにも適用させる場合は、フィルターを削除して、
 * get_the_excerpt フィルターフックに紐付けられた関数に追加してください。
 */
function twentyeleven_custom_excerpt_more( $output ) {
  if ( has_excerpt() && ! is_attachment() ) {
    $output .= twentyeleven_continue_reading_link();
  }
  return $output;
}
add_filter( 'get_the_excerpt', 'twentyeleven_custom_excerpt_more' );

参考資料

最新英語版: WordPress Codex » Plugin API/Filter Reference/get the excerpt最新版との差分