钩子文档

widget_links_args

💡 云策文档标注

概述

widget_links_args 是一个 WordPress 过滤器钩子,用于修改 Links 小部件检索链接列表时的参数数组。它允许开发者在输出链接前自定义查询条件。

关键要点

  • 这是一个过滤器钩子,用于过滤 Links 小部件的参数
  • 接受两个参数:$widget_links_args(参数数组)和 $instance(小部件实例设置)
  • 在 wp_list_bookmarks() 函数中被调用,用于生成链接列表
  • 从 WordPress 2.6.0 版本引入,4.4.0 版本添加了 $instance 参数
  • 与 WP_Widget_Links::widget() 方法关联,用于输出 Links 小部件内容

代码示例

wp_list_bookmarks( apply_filters( 'widget_links_args', $widget_links_args, $instance ) );

注意事项

使用此钩子时,应确保返回的参数数组符合 wp_list_bookmarks() 函数的期望格式,以避免输出错误。


📄 原文内容

Filters the arguments for the Links widget.

Description

See also

Parameters

$widget_links_argsarray
An array of arguments to retrieve the links list.
$instancearray
The settings for the particular instance of the widget.

Source

wp_list_bookmarks( apply_filters( 'widget_links_args', $widget_links_args, $instance ) );

Changelog

Version Description
4.4.0 Added the $instance parameter.
2.6.0 Introduced.