clean_comment_cache()

clean_comment_cache() は、指定されたコメント ID に関連するキャッシュデータを削除する WordPress の関数です。

コメント情報の内容を直接データベースで変更したり、プログラム的に編集・削除した場合に、キャッシュされた古い情報が表示されるのを防ぐ目的で使用されます。コメントに関するキャッシュ整合性を保つために非常に重要です。

基本構文

clean_comment_cache( $comment_id );

• $comment_id：キャッシュを削除したいコメントの ID を指定します。
• この関数を呼び出すと、get_comment() などで取得されるキャッシュがクリアされ、常に最新のデータが使われるようになります。

引き数と戻り値

使用例

タグを使った使用例

$comment_id = 456;
clean_comment_cache( $comment_id );

このコードは、コメント ID「456」に関するキャッシュを削除します。これにより、次回以降 get_comment(456) や get_comments() を使ったときに、常に最新のコメント情報が取得されます。

注意点

• この関数は「コメント単体」のキャッシュのみを削除します。投稿やユーザー、他の関連エンティティのキャッシュには影響を与えません。
• データベースを直接操作したり、カスタムクエリでコメント情報を変更した場合には、この関数を忘れず呼び出す必要があります。
• コメントが存在しない ID を指定してもエラーにはなりませんが、意味はありません。

よく一緒に使われる関数

get_comment()

clean_comment_cache( $comment_id );
$comment = get_comment( $comment_id );

コメントキャッシュ削除後に、常に最新のコメントデータを取得。

wp_update_comment()

wp_update_comment( [
  'comment_ID' => $comment_id,
  'comment_content' => '更新されたコメント内容',
] );
clean_comment_cache( $comment_id );

コメントをプログラム的に更新後、キャッシュをクリアして最新情報を反映。

wp_delete_comment()

wp_delete_comment( $comment_id, true );
clean_comment_cache( $comment_id );

コメント削除後にキャッシュが残っている場合は手動で削除。

想定されるトラブル

コメント内容を変更しても表示が変わらない

キャッシュが更新されていないため、変更前の情報が表示されている。

解決方法

コメント更新後に clean_comment_cache( $comment_id ) を実行する。

直接DBを編集した後、コメントが反映されない

データベースを直接編集した場合、WordPressのキャッシュ層が古いままになる。

解決方法

キャッシュ削除関数 clean_comment_cache() を明示的に呼び出す。

Q&A

まとめ

clean_comment_cache() は、コメント ID に紐づいたキャッシュを削除し、コメント情報を常に最新状態に保つための関数です。

コメントをプログラムで変更・削除・更新した際には、この関数を明示的に呼び出すことで、表示上のキャッシュ残りによる不整合を防止できます。WordPressのキャッシュ管理において、精度を保つために非常に役立つ補助関数です。