プラグイン API/フィルターフック一覧/get the excerpt

説明

"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' );

参考資料

• フィルター関数の作成
• add_filter()

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