WordPress/wp-content/themes/twentyseventeen/inc/template-functions.php
Joe McGill 030bc377dd 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.
Built from https://develop.svn.wordpress.org/trunk@38985


git-svn-id: http://core.svn.wordpress.org/trunk@38928 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2016-10-27 21:51:31 +00:00

100 lines
2.3 KiB
PHP

<?php
/**
* Additional features to allow styling of the templates
*
* @package WordPress
* @subpackage Twenty_Seventeen
* @since 1.0
*/
/**
* Adds custom classes to the array of body classes.
*
* @param array $classes Classes for the body element.
* @return array
*/
function twentyseventeen_body_classes( $classes ) {
// Add class of group-blog to blogs with more than 1 published author.
if ( is_multi_author() ) {
$classes[] = 'group-blog';
}
// Add class of hfeed to non-singular pages.
if ( ! is_singular() ) {
$classes[] = 'hfeed';
}
// Add class if we're viewing the Customizer for easier styling of theme options.
if ( is_customize_preview() ) {
$classes[] = 'twentyseventeen-customizer';
}
// Add class on front page.
if ( is_front_page() && 'posts' !== get_option( 'show_on_front' ) ) {
$classes[] = 'twentyseventeen-front-page';
}
// Add a class if there is a custom header.
if ( has_header_image() || has_header_video() && is_front_page() ) {
$classes[] = 'has-header-image';
}
// Add class if sidebar is used.
if ( is_active_sidebar( 'sidebar-1' ) && ! is_page() ) {
$classes[] = 'has-sidebar';
}
// Add class for one or two column page layouts.
if ( is_page() ) {
if ( 'one-column' === get_theme_mod( 'page_options' ) ) {
$classes[] = 'page-one-column';
} else {
$classes[] = 'page-two-column';
}
}
// Add class if the site title and tagline is hidden.
if ( 'blank' === get_header_textcolor() ) {
$classes[] = 'title-tagline-hidden';
}
// Get the colorscheme or the default if there isn't one.
$colors = twentyseventeen_sanitize_colorscheme( get_theme_mod( 'colorscheme', 'light' ) );
$classes[] = 'colors-' . $colors;
return $classes;
}
add_filter( 'body_class', 'twentyseventeen_body_classes' );
/**
* Count our number of active panels.
*
* Primarily used to see if we have any panels active, duh.
*/
function twentyseventeen_panel_count() {
$panels = array( '1', '2', '3', '4' );
$panel_count = 0;
foreach ( $panels as $panel ) {
if ( get_theme_mod( 'panel_' . $panel ) ) {
$panel_count++;
}
}
return $panel_count;
}
/**
* Checks to see if we're on the homepage or not.
*/
function twentyseventeen_is_frontpage() {
return ( is_front_page() && ! is_home() );
}
/**
* Custom Active Callback to check for page.
*/
function twentyseventeen_is_page() {
return ( is_page() );
}