概要
clean_taxonomy_cache関数は、指定したタクソノミー関連のキャッシュをクリアするために使用されます。この関数は、カスタムタクソノミーやカテゴリ、タグなど、ワードプレスで用いられる様々なタクソノミーが持つキャッシュをクリーンアップする際に役立ちます。そうすることで、タクソノミーの情報が最新の状態に保たれ、正確なデータが表示されるようになります。
この関数がよく使われるシチュエーションは以下の通りです：
1. カスタムタクソノミーの作成時 – 新しくタクソノミーを追加したとき。
2. タクソノミーの用語が変更されたとき – タクソノミーに関連する用語の名前や親子関係が変更された際。
3. 投稿の公開または更新時 – 投稿が公開または更新されたとき、それに関連するタクソノミーのキャッシュをクリア。
4. タクソノミーの削除 – 不要になったタクソノミーを削除した後。
5. プラグインのインストールや更新時 – プラグインがタクソノミーを使用している場合、そのインストールや更新後。
6. 設定の変更 – タクソノミーに関する設定を変更した後。
7. テーマの更新時 – テーマがタクソノミーに依存している場合、テーマを更新したとき。
8. データベースの下位互換性の維持 – 古いデータが残っている場合に、それをクリーンアップ。
構文
clean_taxonomy_cache( $taxonomy = '' );
パラメータ
$taxonomy(string) (オプション): キャッシュをクリアしたいタクソノミーの名前。指定しない場合は全てのタクソノミーのキャッシュがクリアされます。
戻り値
- なし。キャッシュがクリアされる。
関連する関数
使用可能なバージョン
- WordPress 2.8.0 以降で使用可能。
コアファイルのパス
wp-includes/taxonomy.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 |
非推奨または削除されたバージョン
- 現在、特定のバージョンで非推奨または削除されていません。