Changeset 39240

Timestamp:

11/15/2016 07:15:20 AM (8 years ago)

Author:

peterwilsoncc

Message:

Themes: Remove front page restriction from video header functions.

Adds a callback for determining when video headers should be displayed in themes supporting custom headers. By default, video headers are only displayed on the front page of a site.

Theme authors may set a custom callback by passing 'video-active-callback' => 'mytheme_video_active_callback' as an argument. The default callback is is_front_page().

This introduces the new function is_header_video_active() - returns true on pages that should display video headers. The return value can be filtered using the new filter of the same name.

Props flixos90, bradyvercher, peterwilsoncc, joemcgill.
Fixes #38738.

Location:

trunk

Files:

• src/wp-includes/class-wp-customize-manager.php (modified) (1 diff)
• src/wp-includes/theme.php (modified) (4 diffs)
• tests/phpunit/tests/theme/customHeader.php (added)

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

@@ -3492 +3492 @@
                 'frame_button' => __( 'Choose Video' ),
             ),
-            'active_callback' => 'is_front_page',
+            'active_callback' => 'is_header_video_active',
         ) ) );
 

trunk/src/wp-includes/theme.php

@@ -1401 +1401 @@
  */
 function has_custom_header() {
-    if ( has_header_image() || ( is_front_page() && has_header_video() ) ) {
+    if ( has_header_image() || ( has_header_video() && is_header_video_active() ) ) {
         return true;
     }
 
     return false;
+}
+
+/**
+ * Checks whether the custom header video is eligible to show on the current page.
+ *
+ * @since 4.7.0
+ *
+ * @return bool True if the custom header video should be shown. False if not.
+ */
+function is_header_video_active() {
+    if ( ! get_theme_support( 'custom-header', 'video' ) ) {
+        return false;
+    }
+
+    $video_active_cb = get_theme_support( 'custom-header', 'video-active-callback' );
+
+    if ( empty( $video_active_cb ) || ! is_callable( $video_active_cb ) ) {
+        $show_video = true;
+    } else {
+        $show_video = call_user_func( $video_active_cb );
+    }
+
+    /**
+     * Modify whether the custom header video is eligible to show on the current page.
+     *
+     * @since 4.7.0
+     *
+     * @param bool $show_video Whether the custom header video should be shown. Returns the value
+     *                         of the theme setting for the `custom-header`'s `video-active-callback`.
+     *                         If no callback is set, the default value is that of `is_front_page()`.
+     */
+    return apply_filters( 'is_header_video_active', $show_video );
 }
 
@@ -1443 +1475 @@
     echo $custom_header;
 
-    if ( is_front_page() && ( has_header_video() || is_customize_preview() ) ) {
+    if ( is_header_video_active() && ( has_header_video() || is_customize_preview() ) ) {
         wp_enqueue_script( 'wp-custom-header' );
         wp_localize_script( 'wp-custom-header', '_wpCustomHeaderSettings', get_header_video_settings() );
@@ -2059 +2091 @@
                 'admin-preview-callback' => '',
                 'video' => false,
+                'video-active-callback' => 'is_front_page',
             );
 
@@ -2320 +2353 @@
                 break;
             $support = get_theme_support( 'custom-header' );
-            if ( $support[0]['wp-head-callback'] )
+            if ( isset( $support[0]['wp-head-callback'] ) ) {
                 remove_action( 'wp_head', $support[0]['wp-head-callback'] );
-            remove_action( 'admin_menu', array( $GLOBALS['custom_image_header'], 'init' ) );
-            unset( $GLOBALS['custom_image_header'] );
+            }
+            if ( isset( $GLOBALS['custom_image_header'] ) ) {
+                remove_action( 'admin_menu', array( $GLOBALS['custom_image_header'], 'init' ) );
+                unset( $GLOBALS['custom_image_header'] );
+            }
             break;