钩子文档

display_media_states

💡 云策文档标注

概述

display_media_states 是一个 WordPress 过滤器,用于修改媒体库列表中媒体项的默认显示状态。它允许开发者自定义媒体状态数组,并自 WordPress 4.8.0 起添加了 $post 参数以提供更多上下文。

关键要点

  • 过滤器名称:display_media_states
  • 参数:$media_states(数组,默认包含 'Header Image'、'Background Image'、'Site Icon'、'Logo' 等状态)和 $post(WP_Post 对象,表示当前附件)
  • 用途:过滤媒体列表表中的媒体显示状态,常用于自定义媒体状态或基于附件对象调整状态
  • 相关函数:get_media_states() 用于从附件检索媒体状态数组
  • 版本历史:WordPress 3.2.0 引入,4.8.0 添加 $post 参数

代码示例

apply_filters( 'display_media_states', $media_states, $post );

📄 原文内容

Filters the default media display states for items in the Media list table.

Parameters

$media_statesstring[]
An array of media states. Default ‘Header Image’, ‘Background Image’, ‘Site Icon’, 'Logo'.
$postWP_Post
The current attachment object.

Source

return apply_filters( 'display_media_states', $media_states, $post );

Changelog

Version Description
4.8.0 Added the $post parameter.
3.2.0 Introduced.