Changeset 38985 for trunk/src/wp-includes/class-wp-customize-manager.php

Timestamp:

10/27/2016 09:50:56 PM (5 years ago)

Author:

joemcgill

Message:

Themes: Enable video in custom headers.

This adds the ability for themes to add support for videos in custom headers
by passing 'video' => true as an argument when adding theme support for
custom headers.

Custom video headers are managed through the “Header Visuals” (i.e. “Header Image”)
panel in the Customizer where you can select a video from the media library or set a
URL to an external video (YouTube for now) for use in custom headers.

This introduces several new functions:

has_header_video() – Check whether a header video is set or not.
get_header_video_url() – Retrieve header video URL for custom header.
the_header_video_url() – Display header video URL.
get_header_video_settings() – Retrieve header video settings.
has_custom_header() – Check whether a custom header is set or not.
get_custom_header_markup() – Retrieve the markup for a custom header.
the_custom_header_markup() – Print the markup for a custom header.

And a new file, wp-includes/js/wp-custom-header.js that handles loading videos
in custom headers.

This also enables video headers in the Twenty Seventeen and Twenty Fourteen themes.

Props davidakennedy, celloexpressions, bradyvercher, laurelfulford, joemcgill.
Fixes #38172.

File:

• trunk/src/wp-includes/class-wp-customize-manager.php (modified) (4 diffs)

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -363 +363 @@
         add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_section_templates' ), 1 );
         add_action( 'customize_controls_print_footer_scripts', array( $this, 'render_control_templates' ), 1 );
+
+        // Export header video settings with the partial response.
+        add_filter( 'customize_render_partials_response', array( $this, 'export_header_video_settings' ), 10, 3 );
 
         // Export the settings to JS via the _wpCustomizeSettings variable.
@@ -3250 +3253 @@
         /* Custom Header */
 
+        if ( current_theme_supports( 'custom-header', 'video' ) ) {
+            $title = __( 'Header Visuals' );
+            $description = __( 'If you add a video, the image will be used as a fallback while the video loads.' );
+            $width = absint( get_theme_support( 'custom-header', 'width' ) );
+            $height = absint( get_theme_support( 'custom-header', 'height' ) );
+            if ( $width && $height ) {
+                /* translators: %s: header size in pixels */
+                $control_description = sprintf( __( 'Upload your video in <code>.mp4</code> format and minimize its file size for best results. Your theme recommends dimensions of %s pixels.' ),
+                    sprintf( '<strong>%s &times; %s</strong>', $width, $height )
+                );
+            } elseif ( $width ) {
+                /* translators: %s: header width in pixels */
+                $control_description = sprintf( __( 'Upload your video in <code>.mp4</code> format and minimize its file size for best results. Your theme recommends a width of %s pixels.' ),
+                    sprintf( '<strong>%s</strong>', $width )
+                );
+            } else {
+                /* translators: %s: header height in pixels */
+                $control_description = sprintf( __( 'Upload your video in <code>.mp4</code> format and minimize its file size for best results. Your theme recommends a height of %s pixels.' ),
+                    sprintf( '<strong>%s</strong>', $height )
+                );
+            }
+        } else {
+            $title = __( 'Header Image' );
+            $description = '';
+            $control_description = '';
+        }
+
         $this->add_section( 'header_image', array(
-            'title'          => __( 'Header Image' ),
+            'title'          => $title,
+            'description'    => $description,
             'theme_supports' => 'custom-header',
             'priority'       => 60,
+        ) );
+
+        $this->add_setting( 'header_video', array(
+            'theme_supports'    => array( 'custom-header', 'video' ),
+            'transport'         => 'postMessage',
+            'sanitize_callback' => 'absint',
+            'validate_callback' => array( $this, '_validate_header_video' ),
+        ) );
+
+        $this->add_setting( 'external_header_video', array(
+            'theme_supports'    => array( 'custom-header', 'video' ),
+            'transport'         => 'postMessage',
+            'sanitize_callback' => 'esc_url',
+            'validate_callback' => array( $this, '_validate_external_header_video' ),
         ) );
 
@@ -3266 +3311 @@
         ) ) );
 
+        $this->add_control( new WP_Customize_Media_Control( $this, 'header_video', array(
+            'theme_supports' => array( 'custom-header', 'video' ),
+            'label'          => __( 'Header Video' ),
+            'description'    => $control_description,
+            'section'        => 'header_image',
+            'mime_type'      => 'video',
+        ) ) );
+
+        $this->add_control( 'external_header_video', array(
+            'theme_supports' => array( 'custom-header', 'video' ),
+            'type'           => 'url',
+            'description'    => __( 'Or, enter a YouTube or Vimeo URL:' ),
+            'section'        => 'header_image',
+        ) );
+
         $this->add_control( new WP_Customize_Header_Image_Control( $this ) );
+
+        $this->selective_refresh->add_partial( 'custom_header', array(
+            'selector'            => '#wp-custom-header',
+            'render_callback'     => 'the_custom_header_markup',
+            'settings'            => array( 'header_video', 'external_header_video', 'header_image' ), // The image is used as a video fallback here.
+            'container_inclusive' => true,
+        ) );
 
         /* Custom Background */
@@ -3706 +3773 @@
 
     /**
+     * Export header video settings to facilitate selective refresh.
+     *
+     * @since 4.7.0
+     *
+     * @param array $response Response.
+     * @param WP_Customize_Selective_Refresh $selective_refresh Selective refresh component.
+     * @param array $partials Array of partials.
+     * @return array
+     */
+    public function export_header_video_settings( $response, $selective_refresh, $partials ) {
+        if ( isset( $partials['header_video'] ) || isset( $partials['external_header_video'] ) ) {
+            $response['custom_header_settings'] = get_header_video_settings();
+        }
+
+        return $response;
+    }
+
+    /**
+     * Callback for validating the header_video value.
+     *
+     * Ensures that the selected video is less than 8MB and provides an error message.
+     *
+     * @since 4.7.0
+     *
+     * @param WP_Error $validity
+     * @param mixed $value
+     * @return mixed
+     */
+    public function _validate_header_video( $validity, $value ) {
+        $video = get_attached_file( absint( $value ) );
+        if ( $video ) {
+            $size = filesize( $video );
+            if ( 8 < $size / pow( 1024, 2 ) ) { // Check whether the size is larger than 8MB.
+                $validity->add( 'size_too_large', __( 'This video file is too large to use as a header video. Try a shorter video or optimize the compression settings and re-upload a file that is less than 8MB. Or, upload your video to YouTube and link it with the option below.' ) );
+            }
+            if ( '.mp4' !== substr( $video, -4 ) && '.mov' !== substr( $video, -4 ) ) { // Check for .mp4 or .mov format, which (assuming h.264 encoding) are the only cross-browser-supported formats.
+                $validity->add( 'invalid_file_type', __( 'Only <code>.mp4</code> or <code>.mov</code> files may be used for header video. Please convert your video file and try again, or, upload your video to YouTube and link it with the option below.' ) );
+            }
+        }
+        return $validity;
+    }
+
+    /**
+     * Callback for validating the external_header_video value.
+     *
+     * Ensures that the provided URL is for YouTube or Vimeo.
+     *
+     * @since 4.7.0
+     *
+     * @param WP_Error $validity
+     * @param mixed $value
+     * @return mixed
+     */
+    public function _validate_external_header_video( $validity, $value ) {
+        $video = esc_url( $value );
+        if ( $video ) {
+            if ( ! preg_match( '#^https?://(?:www\.)?(?:youtube\.com/watch|youtu\.be/)#', $video )
+                 && ! preg_match( '#^https?://(.+\.)?vimeo\.com/.*#', $video ) ) {
+                $validity->add( 'invalid_url', __( 'Please enter a valid YouTube or Vimeo video URL.' ) );
+            }
+        }
+        return $validity;
+    }
+
+    /**
      * Callback for rendering the custom logo, used in the custom_logo partial.
      *