WP_Widget_Media_Video
云策文档标注
概述
WP_Widget_Media_Video 是 WordPress 核心类,用于实现视频小部件,继承自 WP_Widget_Media。它支持从媒体库或外部服务(如 YouTube、Vimeo)加载视频,并提供前端渲染和管理功能。
关键要点
- 继承自 WP_Widget_Media,专门处理视频内容,MIME 类型为 'video'。
- 构造函数初始化小部件,设置本地化字符串,支持多语言。
- get_instance_schema() 方法定义小部件实例的属性模式,包括预加载、循环和轨道等选项。
- render_media() 方法负责前端视频渲染,支持附件、YouTube 和 Vimeo 链接,自动注入样式以适应侧边栏。
- inject_video_max_width_style() 方法移除视频的固定高度和宽度,添加最大宽度样式以优化显示。
- enqueue_admin_scripts() 和 enqueue_preview_scripts() 方法加载管理界面和预览所需的脚本。
- render_control_template_scripts() 方法渲染表单模板脚本,扩展父类功能。
代码示例
// 示例:使用 WP_Widget_Media_Video 渲染视频
$video_widget = new WP_Widget_Media_Video();
$instance = array(
'url' => 'https://example.com/video.mp4',
'preload' => 'metadata',
'loop' => false
);
$video_widget->render_media($instance);注意事项
- 视频小部件支持多种视频扩展格式,如 mp4、webm 等,通过 wp_get_video_extensions() 获取。
- 前端渲染时,会自动处理 YouTube 和 Vimeo 的嵌入,使用 wp_video_shortcode 或 wp_oembed_get。
- 样式注入确保视频在侧边栏中自适应,避免布局问题。
原文内容
Core class that implements a video widget.
Description
See also
Methods
| Name | Description |
|---|---|
| WP_Widget_Media_Video::__construct | Constructor. |
| WP_Widget_Media_Video::enqueue_admin_scripts | Loads the required scripts and styles for the widget control. |
| WP_Widget_Media_Video::enqueue_preview_scripts | Enqueue preview scripts. |
| WP_Widget_Media_Video::get_instance_schema | Get schema for properties of a widget instance (item). |
| WP_Widget_Media_Video::inject_video_max_width_style | Inject max-width and remove height for videos too constrained to fit inside sidebars on frontend. |
| WP_Widget_Media_Video::render_control_template_scripts | Render form template scripts. |
| WP_Widget_Media_Video::render_media | Render the media on the frontend. |
Source
class WP_Widget_Media_Video extends WP_Widget_Media {
/**
* Constructor.
*
* @since 4.8.0
*/
public function __construct() {
parent::__construct(
'media_video',
__( 'Video' ),
array(
'description' => __( 'Displays a video from the media library or from YouTube, Vimeo, or another provider.' ),
'mime_type' => 'video',
)
);
$this->l10n = array_merge(
$this->l10n,
array(
'no_media_selected' => __( 'No video selected' ),
'add_media' => _x( 'Add Video', 'label for button in the video widget' ),
'replace_media' => _x( 'Replace Video', 'label for button in the video widget; should preferably not be longer than ~13 characters long' ),
'edit_media' => _x( 'Edit Video', 'label for button in the video widget; should preferably not be longer than ~13 characters long' ),
'missing_attachment' => sprintf(
/* translators: %s: URL to media library. */
__( 'That video cannot be found. Check your <a href="%s">media library</a> and make sure it was not deleted.' ),
esc_url( admin_url( 'upload.php' ) )
),
/* translators: %d: Widget count. */
'media_library_state_multi' => _n_noop( 'Video Widget (%d)', 'Video Widget (%d)' ),
'media_library_state_single' => __( 'Video Widget' ),
/* translators: %s: A list of valid video file extensions. */
'unsupported_file_type' => sprintf( __( 'Sorry, the video at the supplied URL cannot be loaded. Please check that the URL is for a supported video file (%s) or stream (e.g. YouTube and Vimeo).' ), '<code>.' . implode( ', .', wp_get_video_extensions() ) . '' ),
)
);
}
/**
* Get schema for properties of a widget instance (item).
*
* @since 4.8.0
*
* @see WP_REST_Controller::get_item_schema()
* @see WP_REST_Controller::get_additional_fields()
* @link https://core.trac.wordpress.org/ticket/35574
*
* @return array Schema for properties.
*/
public function get_instance_schema() {
$schema = array(
'preload' => array(
'type' => 'string',
'enum' => array( 'none', 'auto', 'metadata' ),
'default' => 'metadata',
'description' => __( 'Preload' ),
'should_preview_update' => false,
),
'loop' => array(
'type' => 'boolean',
'default' => false,
'description' => __( 'Loop' ),
'should_preview_update' => false,
),
'content' => array(
'type' => 'string',
'default' => '',
'sanitize_callback' => 'wp_kses_post',
'description' => __( 'Tracks (subtitles, captions, descriptions, chapters, or metadata)' ),
'should_preview_update' => false,
),
);
foreach ( wp_get_video_extensions() as $video_extension ) {
$schema[ $video_extension ] = array(
'type' => 'string',
'default' => '',
'format' => 'uri',
/* translators: %s: Video extension. */
'description' => sprintf( __( 'URL to the %s video source file' ), $video_extension ),
);
}
return array_merge( $schema, parent::get_instance_schema() );
}
/**
* Render the media on the frontend.
*
* @since 4.8.0
*
* @param array $instance Widget instance props.
*/
public function render_media( $instance ) {
$instance = array_merge( wp_list_pluck( $this->get_instance_schema(), 'default' ), $instance );
$attachment = null;
if ( $this->is_attachment_with_mime_type( $instance['attachment_id'], $this->widget_options['mime_type'] ) ) {
$attachment = get_post( $instance['attachment_id'] );
}
$src = $instance['url'];
if ( $attachment ) {
$src = wp_get_attachment_url( $attachment->ID );
}
if ( empty( $src ) ) {
return;
}
$youtube_pattern = '#^https?://(?:www.)?(?:youtube.com/watch|youtu.be/)#';
$vimeo_pattern = '#^https?://(.+.)?vimeo.com/.*#';
if ( $attachment || preg_match( $youtube_pattern, $src ) || preg_match( $vimeo_pattern, $src ) ) {
add_filter( 'wp_video_shortcode', array( $this, 'inject_video_max_width_style' ) );
echo wp_video_shortcode(
array_merge(
$instance,
compact( 'src' )
),
$instance['content']
);
remove_filter( 'wp_video_shortcode', array( $this, 'inject_video_max_width_style' ) );
} else {
echo $this->inject_video_max_width_style( wp_oembed_get( $src ) );
}
}
/**
* Inject max-width and remove height for videos too constrained to fit inside sidebars on frontend.
*
* @since 4.8.0
*
* @param string $html Video shortcode HTML output.
* @return string HTML Output.
*/
public function inject_video_max_width_style( $html ) {
$html = preg_replace( '/sheight="d+"/', '', $html );
$html = preg_replace( '/swidth="d+"/', '', $html );
$html = preg_replace( '/(?get_instance_schema() as $field => $field_schema ) {
$exported_schema[ $field ] = wp_array_slice_assoc( $field_schema, array( 'type', 'default', 'enum', 'minimum', 'format', 'media_prop', 'should_preview_update' ) );
}
wp_add_inline_script(
$handle,
sprintf(
'wp.mediaWidgets.modelConstructors[ %s ].prototype.schema = %s;',
wp_json_encode( $this->id_base, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ),
wp_json_encode( $exported_schema, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES )
)
);
wp_add_inline_script(
$handle,
sprintf(
'
wp.mediaWidgets.controlConstructors[ %1$s ].prototype.mime_type = %2$s;
wp.mediaWidgets.controlConstructors[ %1$s ].prototype.l10n = _.extend( {}, wp.mediaWidgets.controlConstructors[ %1$s ].prototype.l10n, %3$s );
',
wp_json_encode( $this->id_base, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ),
wp_json_encode( $this->widget_options['mime_type'], JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ),
wp_json_encode( $this->l10n, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES )
)
);
}
/**
* Render form template scripts.
*
* @since 4.8.0
*/
public function render_control_template_scripts() {
parent::render_control_template_scripts()
?>
l10n['missing_attachment'],
array(
'type' => 'error',
'additional_classes' => array( 'notice-alt', 'notice-missing-attachment' ),
)
);
?>
l10n['unsupported_file_type'],
array(
'type' => 'error',
'additional_classes' => array( 'notice-alt', 'notice-missing-attachment' ),
)
);
?>
'error',
'additional_classes' => array( 'notice-alt' ),
)
);
?>
Changelog
| Version | Description |
|---|---|
| 4.8.0 | Introduced. |