钩子文档

widget_{$this->id_base}_instance

💡 云策文档标注

概述

这是一个 WordPress 钩子,用于在渲染媒体小部件之前过滤其实例数据。它允许开发者在显示前修改小部件的实例数据。

关键要点

  • 钩子名称:widget_{$this->id_base}_instance,用于媒体小部件实例过滤。
  • 参数:$instance(实例数据数组)、$args(小部件参数数组)、$widget(WP_Widget_Media 对象)。
  • 应用场景:在 WP_Widget_Media::widget() 方法中调用,用于前端显示前的数据调整。
  • 版本历史:从 WordPress 4.8.0 版本引入。

代码示例

$instance = apply_filters( "widget_{$this->id_base}_instance", $instance, $args, $this );

📄 原文内容

Filters the media widget instance prior to rendering the media.

Parameters

$instancearray
Instance data.
$argsarray
Widget args.
$widgetWP_Widget_Media
Widget object.

Source

$instance = apply_filters( "widget_{$this->id_base}_instance", $instance, $args, $this );

Changelog

Version Description
4.8.0 Introduced.