File: /var/www/html/wp-content/plugins/wpseo-video/classes/class-wpseo-meta-video.php
<?php
/**
* Yoast SEO Video plugin file.
*
* @package Internals
* @since 1.6.0
* @version 1.6.0
*/
// Avoid direct calls to this file.
if ( ! class_exists( 'WPSEO_Video_Sitemap' ) ) {
header( 'Status: 403 Forbidden' );
header( 'HTTP/1.1 403 Forbidden' );
exit();
}
if ( ! class_exists( 'WPSEO_Meta_Video' ) ) {
/**
* Add the VideoSEO metabox fields and associated validation to the WPSEO-meta management
*
* {@internal WPSEO_Meta is a class with only static methods, so we will not extend it with
* a child class, we will only add to it by hooking in.}
*/
class WPSEO_Meta_Video {
/**
* Meta box field definitions for the meta box form.
*
* @var array {
* @type string $default_value Recommended. Default value for the field.
* IMPORTANT:
* - if the field has options, the default has to be the
* key of one of the options
* - if the field is a text field, the default **has** to be
* an empty string as otherwise the user can't save
* an empty value/delete the meta value.
* @type array $options Semi-required. Options for use with (multi-)select and radio
* fields, required if that's the field type.
* Key = (string) value which will be saved to db.
* Value = (string) text label for the option.
* }
*
* {@internal
* - Fields are rendered as hidden fields always. Translations are done on the JS side.
* - Beware: even though the meta keys are divided into subsets, they still have to be uniquely named!}
*/
public static $meta_fields = [
'video' => [
'videositemap-disable' => [
'type' => 'hidden',
'default_value' => 'off',
],
'videositemap-thumbnail' => [
'type' => 'hidden',
'default_value' => '',
],
'videositemap-duration' => [
'type' => 'hidden',
'default_value' => '0',
'options' => [
'min_value' => '0',
'max_value' => null,
'step' => '1',
],
],
/*
* {@internal Not used directly anywhere except for storage and retrieval of the meta box
* form values. The real use is in the video_meta key which retrieves the value
* of this from $_POST.
* However removing this would cause the meta box field to go blank as the info
* can no longer be retrieved, so leaving it as is for now.}
*/
'videositemap-tags' => [
'type' => 'hidden',
'default_value' => '',
],
/*
* {@internal Not used directly anywhere except for storage and retrieval of the meta box
* form values. The real use is in the video_meta key which retrieves the value
* of this from $_POST.
* However removing this would cause the meta box field to go blank as the info
* can no longer be retrieved, so leaving it as is for now.}
*/
'videositemap-rating' => [
'type' => 'hidden',
'default_value' => 0,
'options' => [
'min_value' => '0',
'max_value' => '5',
'step' => '0.1',
],
],
'videositemap-not-family-friendly' => [
'type' => 'hidden',
'default_value' => 'off',
],
],
/* Fields we should validate & save, but not show on any form */
'non_form' => [
'video_meta' => [
'type' => null,
'default_value' => 'none',
'serialized' => true,
],
],
];
/**
* Hook into WPSEO_Meta
*
* @return void
*/
public static function init() {
add_filter( 'add_extra_wpseo_meta_fields', [ self::class, 'register_video_meta_fields' ] );
add_filter( 'wpseo_metabox_entries_video', [ self::class, 'adjust_video_meta_field_defs' ], 10, 2 );
add_filter( 'wpseo_sanitize_post_meta_' . WPSEO_Meta::$meta_prefix . 'videositemap-duration', [ self::class, 'sanitize_duration' ], 10, 3 );
add_filter( 'wpseo_sanitize_post_meta_' . WPSEO_Meta::$meta_prefix . 'videositemap-rating', [ self::class, 'sanitize_rating' ], 10, 3 );
add_filter( 'wpseo_sanitize_post_meta_' . WPSEO_Meta::$meta_prefix . 'videositemap-thumbnail', [ self::class, 'sanitize_thumbnail_upload' ], 10, 3 );
add_filter( 'wpseo_sanitize_post_meta_' . WPSEO_Meta::$meta_prefix . 'video_meta', [ self::class, 'sanitize_video_meta' ], 10, 2 );
}
/**
* Add the video meta fields to the WPSEO_Meta::$meta_fields definitions
*
* @param array $fields Fields already in place (possibly from other add-on plugins).
*
* @return array
*/
public static function register_video_meta_fields( $fields ) {
return WPSEO_Meta::array_merge_recursive_distinct( $fields, self::$meta_fields );
}
/**
* Prepare the video meta field definitions for display in the metabox
*
* @param string $field_defs Field definitions for the requested tab.
*
* @return array Array containing the meta box field definitions
*/
public static function adjust_video_meta_field_defs( $field_defs ) {
$post = ( ! empty( $GLOBALS['post'] ) ) ? $GLOBALS['post'] : null;
$video = [];
if ( isset( $post->ID ) ) {
$video = WPSEO_Meta::get_value( 'video_meta', $post->ID );
}
if ( isset( $video['duration'] ) ) {
$field_defs['videositemap-duration']['default_value'] = $video['duration'];
}
return $field_defs;
}
/**
* Sanitize the video thumbnail upload post meta
*
* @param mixed $clean Potentially pre-cleaned version of the new meta value.
* @param mixed $meta_value The new value.
* @param string $field_def The field definition for the current meta field.
*
* @return string Cleaned value
*/
public static function sanitize_thumbnail_upload( $clean, $meta_value, $field_def ) {
// Validate as url.
$clean = $field_def['default_value'];
$url = WPSEO_Video_Wrappers::yoast_wpseo_video_sanitize_url( $meta_value );
if ( $url !== '' ) {
$clean = $url;
}
return $clean;
}
/**
* Sanitize the video duration post meta
*
* @param mixed $clean Potentially pre-cleaned version of the new meta value.
* @param mixed $meta_value The new value.
* @param string $field_def The field definition for the current meta field.
*
* @return string Cleaned value
*/
public static function sanitize_duration( $clean, $meta_value, $field_def ) {
$field_def = WPSEO_Meta::get_meta_field_defs( 'video' );
$field_def = $field_def['videositemap-duration'];
$clean = $field_def['default_value'];
$int = WPSEO_Video_Wrappers::yoast_wpseo_video_validate_int( $meta_value );
if ( $int !== false && $int > 0 ) {
$clean = strval( $int );
}
return $clean;
}
/**
* Sanitize the video rating post meta
*
* @param mixed $clean Potentially pre-cleaned version of the new meta value.
* @param mixed $meta_value The new value.
* @param string $field_def The field definition for the current meta field.
*
* @return string Cleaned value
*/
public static function sanitize_rating( $clean, $meta_value, $field_def ) {
$clean = $field_def['default_value'];
if ( is_numeric( $meta_value ) && ( $meta_value >= 0 && $meta_value <= 5 ) ) {
$clean = $meta_value;
}
return $clean;
}
/**
* Sanitize the video meta post meta - set in function, not from user input so no extra validation done
*
* @param mixed $clean Potentially pre-cleaned version of the new meta value.
* @param mixed $meta_value The new value.
*
* @return string Cleaned value
*/
public static function sanitize_video_meta( $clean, $meta_value ) {
if ( is_array( $meta_value ) && $meta_value !== [] ) {
$clean = $meta_value;
}
return $clean;
}
/**
* Upgrade routine to deal with the fall-out of issue #102
*
* @deprecated 14.9
* @codeCoverageIgnore
*
* @return void
*/
public static function re_add_durations() {
_deprecated_function( __METHOD__, 'Yoast Video SEO 14.9' );
}
}
}