mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-28 20:17:45 +01:00
967d29d83d
In addition to syncing the latest changes, this change also merges the theme’s `.scss` files and other related build tool configurations required to compile the theme’s CSS.
This will allow development of the theme to continue on Trac after 5.6 is released and the GitHub repository is archived.
For a full list of changes since [], see e7d5991...aa284fd.
Props poena, luminuu kjellr, aristath, justinahinon.
See #51526.
Built from https://develop.svn.wordpress.org/trunk@49574
git-svn-id: http://core.svn.wordpress.org/trunk@49312 1a063a9b-81f0-0310-95a4-ce76da25c4cd
411 lines
11 KiB
PHP
411 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Dark Mode Class
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Twenty_Twenty_One
|
|
* @since 1.0.0
|
|
*/
|
|
|
|
/**
|
|
* This class is in charge of Dark Mode.
|
|
*/
|
|
class Twenty_Twenty_One_Dark_Mode {
|
|
|
|
/**
|
|
* Instantiate the object.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function __construct() {
|
|
|
|
// Enqueue assets for the block-editor.
|
|
add_action( 'enqueue_block_editor_assets', array( $this, 'editor_custom_color_variables' ) );
|
|
|
|
// Add styles for dark-mode.
|
|
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
|
|
|
|
// Add scripts for customizer controls.
|
|
add_action( 'customize_controls_enqueue_scripts', array( $this, 'customize_controls_enqueue_scripts' ) );
|
|
|
|
// Add customizer controls.
|
|
add_action( 'customize_register', array( $this, 'customizer_controls' ) );
|
|
|
|
// Add HTML classes.
|
|
add_filter( 'twentytwentyone_html_classes', array( $this, 'html_classes' ) );
|
|
|
|
// Add classes to <body> in the dashboard.
|
|
add_filter( 'admin_body_class', array( $this, 'admin_body_classes' ) );
|
|
|
|
// Add the switch on the frontend & customizer.
|
|
add_action( 'wp_footer', array( $this, 'the_switch' ) );
|
|
|
|
// Add the switch in the editor.
|
|
add_action( 'wp_ajax_tt1_dark_mode_editor_switch', array( $this, 'editor_ajax_callback' ) );
|
|
|
|
// Add the privacy policy content.
|
|
add_action( 'admin_init', array( $this, 'add_privacy_policy_content' ) );
|
|
}
|
|
|
|
/**
|
|
* Editor custom color variables & scripts.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function editor_custom_color_variables() {
|
|
if ( ! $this->switch_should_render() ) {
|
|
return;
|
|
}
|
|
$background_color = get_theme_mod( 'background_color', 'D1E4DD' );
|
|
$should_respect_color_scheme = get_theme_mod( 'respect_user_color_preference', false );
|
|
if ( $should_respect_color_scheme && Twenty_Twenty_One_Custom_Colors::get_relative_luminance_from_hex( $background_color ) > 127 ) {
|
|
// Add Dark Mode variable overrides.
|
|
wp_add_inline_style(
|
|
'twenty-twenty-one-custom-color-overrides',
|
|
'.is-dark-theme.is-dark-theme .editor-styles-wrapper { --global--color-background: var(--global--color-dark-gray); --global--color-primary: var(--global--color-light-gray); --global--color-secondary: var(--global--color-light-gray); }'
|
|
);
|
|
}
|
|
wp_enqueue_script(
|
|
'twentytwentyone-dark-mode-support-toggle',
|
|
get_template_directory_uri() . '/assets/js/dark-mode-toggler.js',
|
|
array(),
|
|
'1.0.0',
|
|
true
|
|
);
|
|
|
|
wp_enqueue_script(
|
|
'twentytwentyone-editor-dark-mode-support',
|
|
get_template_directory_uri() . '/assets/js/editor-dark-mode-support.js',
|
|
array( 'twentytwentyone-dark-mode-support-toggle' ),
|
|
'1.0.0',
|
|
true
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Enqueue scripts and styles.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function enqueue_scripts() {
|
|
if ( ! $this->switch_should_render() ) {
|
|
return;
|
|
}
|
|
$url = get_template_directory_uri() . '/assets/css/style-dark-mode.css';
|
|
if ( is_rtl() ) {
|
|
$url = get_template_directory_uri() . '/assets/css/style-dark-mode-rtl.css';
|
|
}
|
|
wp_enqueue_style( 'tt1-dark-mode', $url, array( 'twenty-twenty-one-style' ), wp_get_theme()->get( 'Version' ) ); // @phpstan-ignore-line. Version is always a string.
|
|
}
|
|
|
|
/**
|
|
* Enqueue scripts for the customizer.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function customize_controls_enqueue_scripts() {
|
|
if ( ! $this->switch_should_render() ) {
|
|
return;
|
|
}
|
|
wp_enqueue_script(
|
|
'twentytwentyone-customize-controls',
|
|
get_template_directory_uri() . '/assets/js/customize.js',
|
|
array( 'customize-base', 'customize-controls', 'underscore', 'jquery', 'twentytwentyone-customize-helpers' ),
|
|
'1.0.0',
|
|
true
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Register customizer options.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param WP_Customize_Manager $wp_customize Theme Customizer object.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function customizer_controls( $wp_customize ) {
|
|
|
|
$colors_section = $wp_customize->get_section( 'colors' );
|
|
if ( is_object( $colors_section ) ) {
|
|
$colors_section->title = __( 'Colors & Dark Mode', 'twentytwentyone' );
|
|
$colors_section->description = __( 'To access the Dark Mode settings, select a light background color.', 'twentytwentyone' ) . '<br><a href="https://wordpress.org/support/article/twenty-twenty-one/">' . __( 'Learn more about Dark Mode.', 'twentytwentyone' ) . '</a>';
|
|
}
|
|
|
|
$wp_customize->add_setting(
|
|
'respect_user_color_preference',
|
|
array(
|
|
'capability' => 'edit_theme_options',
|
|
'default' => false,
|
|
'sanitize_callback' => function( $value ) {
|
|
return (bool) $value;
|
|
},
|
|
)
|
|
);
|
|
|
|
$wp_customize->add_control(
|
|
'respect_user_color_preference',
|
|
array(
|
|
'type' => 'checkbox',
|
|
'section' => 'colors',
|
|
'label' => esc_html__( 'Dark Mode Support', 'twentytwentyone' ),
|
|
'description' => __( 'Respect visitor\'s device dark mode settings.<br>Dark mode is a device setting. If a visitor to your site requests it, your site will be shown with a dark background and light text.<br><br>Dark Mode can also be turned on and off with a button that you can find in the bottom right corner of the page.', 'twentytwentyone' ),
|
|
'active_callback' => function( $value ) {
|
|
return 127 < Twenty_Twenty_One_Custom_Colors::get_relative_luminance_from_hex( get_theme_mod( 'background_color', 'D1E4DD' ) );
|
|
},
|
|
)
|
|
);
|
|
|
|
// Add partial for background_color.
|
|
$wp_customize->selective_refresh->add_partial(
|
|
'background_color',
|
|
array(
|
|
'selector' => '#dark-mode-toggler',
|
|
'container_inclusive' => true,
|
|
'render_callback' => function() {
|
|
$attrs = ( $this->switch_should_render() ) ? array() : array( 'style' => 'display:none;' );
|
|
$this->the_html( $attrs );
|
|
},
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Calculate classes for the main <html> element.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $classes The classes for <html> element.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function html_classes( $classes ) {
|
|
if ( ! $this->switch_should_render() ) {
|
|
return $classes;
|
|
}
|
|
|
|
$background_color = get_theme_mod( 'background_color', 'D1E4DD' );
|
|
$should_respect_color_scheme = get_theme_mod( 'respect_user_color_preference', false );
|
|
if ( $should_respect_color_scheme && 127 <= Twenty_Twenty_One_Custom_Colors::get_relative_luminance_from_hex( $background_color ) ) {
|
|
return ( $classes ) ? ' respect-color-scheme-preference' : 'respect-color-scheme-preference';
|
|
}
|
|
|
|
return $classes;
|
|
}
|
|
|
|
/**
|
|
* Adds a class to the <body> element in the editor to accommodate dark-mode.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param string $classes The admin body-classes.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function admin_body_classes( $classes ) {
|
|
if ( ! $this->switch_should_render() ) {
|
|
return $classes;
|
|
}
|
|
|
|
global $current_screen;
|
|
if ( empty( $current_screen ) ) {
|
|
set_current_screen();
|
|
}
|
|
|
|
if ( $current_screen->is_block_editor() ) {
|
|
$should_respect_color_scheme = get_theme_mod( 'respect_user_color_preference', false );
|
|
$background_color = get_theme_mod( 'background_color', 'D1E4DD' );
|
|
|
|
if ( $should_respect_color_scheme && Twenty_Twenty_One_Custom_Colors::get_relative_luminance_from_hex( $background_color ) > 127 ) {
|
|
$classes .= ' twentytwentyone-supports-dark-theme';
|
|
}
|
|
}
|
|
|
|
return $classes;
|
|
}
|
|
|
|
/**
|
|
* Determine if we want to print the dark-mode switch or not.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function switch_should_render() {
|
|
global $is_IE;
|
|
return (
|
|
get_theme_mod( 'respect_user_color_preference', false ) &&
|
|
! $is_IE &&
|
|
127 <= Twenty_Twenty_One_Custom_Colors::get_relative_luminance_from_hex( get_theme_mod( 'background_color', 'D1E4DD' ) )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Add night/day switch.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function the_switch() {
|
|
if ( ! $this->switch_should_render() ) {
|
|
return;
|
|
}
|
|
$this->the_html();
|
|
$this->the_script();
|
|
}
|
|
|
|
/**
|
|
* Print the dark-mode switch HTML.
|
|
*
|
|
* Inspired from https://codepen.io/aaroniker/pen/KGpXZo (MIT-licensed)
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param array $attrs The attributes to add to our <button> element.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function the_html( $attrs = array() ) {
|
|
$attrs = wp_parse_args(
|
|
$attrs,
|
|
array(
|
|
'id' => 'dark-mode-toggler',
|
|
'class' => 'fixed-bottom',
|
|
'aria-pressed' => 'false',
|
|
'onClick' => 'toggleDarkMode()',
|
|
)
|
|
);
|
|
echo '<button';
|
|
foreach ( $attrs as $key => $val ) {
|
|
echo ' ' . esc_attr( $key ) . '="' . esc_attr( $val ) . '"';
|
|
}
|
|
echo '>';
|
|
printf(
|
|
/* translators: %s: On/Off */
|
|
esc_html__( 'Dark Mode: %s', 'twentytwentyone' ),
|
|
'<span aria-hidden="true"></span>'
|
|
);
|
|
echo '</button>';
|
|
?>
|
|
<style>
|
|
#dark-mode-toggler > span {
|
|
margin-<?php echo is_rtl() ? 'right' : 'left'; ?>: 5px;
|
|
}
|
|
#dark-mode-toggler > span::before {
|
|
content: '<?php esc_attr_e( 'Off', 'twentytwentyone' ); ?>';
|
|
}
|
|
#dark-mode-toggler[aria-pressed="true"] > span::before {
|
|
content: '<?php esc_attr_e( 'On', 'twentytwentyone' ); ?>';
|
|
}
|
|
<?php if ( is_admin() || wp_is_json_request() ) : ?>
|
|
.components-editor-notices__pinned ~ .edit-post-visual-editor #dark-mode-toggler {
|
|
z-index: 20;
|
|
}
|
|
.is-dark-theme.is-dark-theme #dark-mode-toggler:not(:hover):not(:focus) {
|
|
color: var(--global--color-primary);
|
|
}
|
|
@media only screen and (max-width: 782px) {
|
|
#dark-mode-toggler {
|
|
margin-top: 32px;
|
|
}
|
|
}
|
|
<?php endif; ?>
|
|
</style>
|
|
|
|
<?php
|
|
}
|
|
|
|
/**
|
|
* Print the dark-mode switch script.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function the_script() {
|
|
echo '<script>';
|
|
include get_template_directory() . '/assets/js/dark-mode-toggler.js'; // phpcs:ignore WPThemeReview.CoreFunctionality.FileInclude
|
|
echo '</script>';
|
|
}
|
|
|
|
/**
|
|
* Print the dark-mode switch styles.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function the_styles() {
|
|
echo '<style>';
|
|
include get_theme_file_path( 'assets/css/style-dark-mode.css' ); // phpcs:ignore WPThemeReview.CoreFunctionality.FileInclude
|
|
echo '</style>';
|
|
}
|
|
|
|
/**
|
|
* Call the tt1_the_dark_mode_switch and exit.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function editor_ajax_callback() {
|
|
$this->the_html();
|
|
$this->the_styles();
|
|
wp_die();
|
|
}
|
|
|
|
/**
|
|
* Adds information to the privacy policy.
|
|
*
|
|
* @access public
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @return void
|
|
*/
|
|
public function add_privacy_policy_content() {
|
|
if ( ! function_exists( 'wp_add_privacy_policy_content' ) ) {
|
|
return;
|
|
}
|
|
$content = '<p class="privacy-policy-tutorial">' . __( 'Twenty Twenty-One uses LocalStorage when Dark Mode support is enabled.', 'twentytwentyone' ) . '</p>'
|
|
. '<strong class="privacy-policy-tutorial">' . __( 'Suggested Text:', 'twentytwentyone' ) . '</strong> '
|
|
. __( 'This website uses LocalStorage to save the setting when Dark Mode support is turned on or off.<br> LocalStorage is necessary for the setting to work and is only used when a user clicks on the Dark Mode button.<br> No data is saved in the database or transferred.', 'twentytwentyone' );
|
|
wp_add_privacy_policy_content( 'Twenty Twenty-One', wp_kses_post( wpautop( $content, false ) ) );
|
|
}
|
|
|
|
}
|