钩子文档

loop_start

💡 云策文档标注

概述

loop_start 是一个 WordPress 动作钩子,在循环开始时触发,允许开发者在主循环或自定义查询循环开始时执行自定义代码。

关键要点

  • 触发时机:在 WordPress 循环(如主循环或 WP_Query 循环)开始时执行。
  • 参数:接收一个 WP_Query 实例作为参数,通过引用传递,可用于检查或修改查询对象。
  • 用途:常用于在循环开始前添加内容、修改查询或执行其他初始化操作。

代码示例

add_action( 'loop_start', 'wpdocs_loop_start_function' );
function wpdocs_loop_start_function( $query ) {
    if ( condition ) {
        echo 'content';
    } else {
        echo 'content';
    }
}

注意事项

  • 此钩子从 WordPress 2.0.0 版本引入。
  • 在 WP_Query::the_post() 方法中调用,用于设置当前文章。
  • 用户贡献的笔记提供了使用示例,但需注意条件判断和输出内容应根据实际需求调整。

📄 原文内容

Fires once the loop is started.

Parameters

$queryWP_Query
The WP_Query instance (passed by reference).

Source

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

Changelog

Version Description
2.0.0 Introduced.

User Contributed Notes