钩子文档

widget_{$this->id_base}_instance_schema

💡 云策文档标注

概述

此 Hook 用于过滤媒体小部件的实例模式,允许开发者添加额外属性。它主要用于扩展 WP_Widget_Media 及其子类的实例模式定义。

关键要点

  • Hook 名称:widget_{$this->id_base}_instance_schema,其中 $this->id_base 是媒体小部件的基础 ID
  • 参数:$schema(实例模式数组)和 $widget(WP_Widget_MediaWidget 对象)
  • 用途:修改或增强媒体小部件的实例模式,例如添加自定义属性或验证规则
  • 相关函数:WP_Widget_Media_Gallery::get_instance_schema() 和 WP_Widget_Media::get_instance_schema() 使用此 Hook
  • 引入版本:WordPress 4.9.0

📄 原文内容

Filters the media widget instance schema to add additional properties.

Parameters

$schemaarray
Instance schema.
$widgetWP_Widget_Media
Widget object.

Source

$schema = apply_filters( "widget_{$this->id_base}_instance_schema", $schema, $this );

Changelog

Version Description
4.9.0 Introduced.