概要
the_archive_descriptionフィルタは、アーカイブページの説明を表示する際に使用される非常に便利なフィルタです。このフィルタは、アーカイブページのコンテンツをフィルタリングまたは変更するために使われます。具体的には、カテゴリーやタグの説明をカスタマイズしたり、カスタム投稿タイプの説明を変更したりする用途に利用されます。また、他のコンテンツとの整合性を持たせるために、アーカイブの見た目を調整する際にも役立ちます。
このフィルタが実装される一般的な機能は以下の通りです。
- カテゴリー説明のカスタマイズ
- タグ説明の変更
- カスタム投稿タイプの説明の追加
- SEO最適化のためのメタ情報の追加
- 説明文の言語翻訳
- テーマによるスタイリングの調整
- プラグインによる拡張機能の追加
- 説明文の条件付き表示
構文
the_archive_description( $before, $after );
パラメータ
$before（string）: 説明文の前に追加するHTML。$after（string）: 説明文の後に追加するHTML。
戻り値
（string）フィルタされたアーカイブの説明文。
関連する関数
- the_archive_description – アーカイブページの説明を取得し出力する関数。
使用可能なバージョン
WordPress 4.1.0以降。このフィルタについて特に非推奨や削除されたバージョンはありません。
コアファイルのパス
wp-includes/query.php
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 | 〇 |
サンプルコード
サンプル1: カテゴリー説明をカスタマイズ
add_filter('the_archive_description', function($description) {
if (is_category()) {
$description = 'このカテゴリーには、あらゆる種類の記事が含まれています。';
}
return $description;
});
このコードは、カテゴリーアーカイブページの説明をカスタマイズして、特定のメッセージを表示するものです。引用元: https://developer.wordpress.org/reference/hooks/the_archive_description/
サンプル2: タグ説明の変更
add_filter('the_archive_description', function($description) {
if (is_tag()) {
$description = 'このタグに関連するすべての記事をご覧ください。';
}
return $description;
});
このコードは、タグアーカイブページにおいて説明文を変更します。引用元: https://developer.wordpress.org/reference/hooks/the_archive_description/
サンプル3: カスタム投稿タイプの説明を追加
add_filter('the_archive_description', function($description) {
if (is_post_type_archive('custom_post_type')) {
$description .= ' こちらはカスタム投稿タイプのアーカイブです。';
}
return $description;
});
このコードは、特定のカスタム投稿タイプのアーカイブにカスタムメッセージを追加します。引用元: https://developer.wordpress.org/reference/hooks/the_archive_description/
サンプル4: SEO最適化のためのメタ情報の追加
add_filter('the_archive_description', function($description) {
return '<strong>SEO対策:</strong> ' . $description;
});
このコードは、アーカイブの説明文の前にSEO対策のメッセージを追加します。引用元: https://developer.wordpress.org/reference/hooks/the_archive_description/
サンプル5: 説明文の条件付き表示
add_filter('the_archive_description', function($description) {
if (empty($description)) {
return '説明はありません。';
}
return $description;
});
このコードは、アーカイブ説明が空の場合にデフォルトのメッセージを表示するものです。引用元: https://developer.wordpress.org/reference/hooks/the_archive_description/