钩子文档

loop_end

💡 云策文档标注

概述

loop_end 是一个 WordPress 动作钩子,在循环结束时触发,主要用于开发者执行循环结束后的自定义操作。

关键要点

  • 触发时机:在 WordPress 循环(如主查询或自定义查询)结束后立即执行。
  • 参数:接收一个 WP_Query 实例作为参数,通过引用传递,允许修改查询对象。
  • 用途:常用于清理资源、重置变量或执行循环后的特定逻辑。

代码示例

add_action('loop_end', 'my_custom_loop_end_action');
function my_custom_loop_end_action($query) {
    // 在循环结束时执行自定义代码
    // $query 是 WP_Query 实例
    // 例如:记录日志或重置全局变量
}

注意事项

  • 确保在正确的上下文中使用,避免与其他钩子冲突。
  • 参数 $query 是引用传递,修改时需谨慎,以免影响后续查询。

📄 原文内容

Fires once the loop has ended.

Parameters

$queryWP_Query
The WP_Query instance (passed by reference).

Source

do_action_ref_array( 'loop_end', array( &$this ) );

Changelog

Version Description
2.0.0 Introduced.