themes-wordpress/seedlet/classes/class-seedlet-custom-colors.php

<?php declare( strict_types = 1 ); ?>
<?php
/**
 * Seedlet Theme: Custom Colors Class
 *
 * This class is in charge of color customization via the Customizer.
 *
 * Each variable that needs to be updated is defined in the $seedlet_custom_color_variables array below.
 * A customizer setting is created for each color, and custom CSS-variables are enqueued in the front and back end.
 *
 * @package Seedlet
 * @since 1.0.0
 */

class Seedlet_Custom_Colors {

	private $seedlet_custom_color_variables = array();

	function __construct() {

		/**
		 * Define color variables
		 */
		$seedlet_colors                       = array(
			array( '--global--color-background', '#FFFFFF', __( 'Background Color', 'seedlet' ) ),
			array( '--global--color-foreground', '#333333', __( 'Foreground Color', 'seedlet' ) ),
			array( '--global--color-primary', '#000000', __( 'Primary Color', 'seedlet' ) ),
			array( '--global--color-secondary', '#3C8067', __( 'Secondary Color', 'seedlet' ) ),
			array( '--global--color-tertiary', '#FAFBF6', __( 'Tertiary Color', 'seedlet' ) ),
			array( '--global--color-border', '#EFEFEF', __( 'Borders Color', 'seedlet' ) ),
		);
		$this->seedlet_custom_color_variables = apply_filters( 'seedlet_colors', $seedlet_colors );

		/**
		 * Register Customizer actions
		 */
		add_action( 'customize_register', array( $this, 'seedlet_customize_custom_colors_register' ) );

		/**
		 * Enqueue color variables for customizer & frontend.
		 */
		add_action( 'wp_enqueue_scripts', array( $this, 'seedlet_custom_color_variables' ) );

		/**
		 * Enqueue color variables for editor.
		 */
		add_action( 'enqueue_block_editor_assets', array( $this, 'seedlet_editor_custom_color_variables' ) );

		/**
		 * Enqueue contrast checking.
		 */
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'on_customize_controls_enqueue_scripts' ) );
	}

	/**
	 * Find the resulting colour by blending 2 colours
	 * and setting an opacity level for the foreground colour.
	 *
	 * @author J de Silva
	 * @link http://www.gidnetwork.com/b-135.html
	 * @param string $foreground Hexadecimal colour value of the foreground colour.
	 * @param integer $opacity Opacity percentage (of foreground colour). A number between 0 and 100.
	 * @param string $background Optional. Hexadecimal colour value of the background colour. Default is: <code>FFFFFF</code> aka white.
	 * @return string Hexadecimal colour value. <code>false</code> on errors.
	 */
	function seedlet_color_blend_by_opacity( $foreground, $opacity, $background = null ) {
		static $colors_rgb = array(); // stores colour values already passed through the hexdec() functions below.

		if ( ! is_null( $foreground ) ) {
			$foreground = '000000'; // default primary.
		} else {
			$foreground = preg_replace( '/[^0-9a-f]/i', '', $foreground ); //str_replace( '#', '', $foreground );
		}

		if ( ! is_null( $background ) ) {
			$background = 'FFFFFF'; // default background.
		} else {
			$background = preg_replace( '/[^0-9a-f]/i', '', $background );
		}

		$pattern = '~^[a-f0-9]{6,6}$~i'; // accept only valid hexadecimal colour values.

		if ( ! @preg_match( $pattern, $foreground ) or ! @preg_match( $pattern, $background ) ) {
			echo $foreground;
			trigger_error( 'Invalid hexadecimal color value(s) found', E_USER_WARNING );
			return false;
		}

		$opacity = intval( $opacity ); // validate opacity data/number.

		if ( $opacity > 100 || $opacity < 0 ) {
			trigger_error( 'Opacity percentage error, valid numbers are between 0 - 100', E_USER_WARNING );
			return false;
		}

		if ( $opacity == 100 ) {  // $transparency == 0
			return strtoupper( $foreground );
		}
		if ( $opacity == 0 ) {    // $transparency == 100
			return strtoupper( $background );
		}

		// calculate $transparency value.
		$transparency = 100 - $opacity;

		if ( ! isset( $colors_rgb[ $foreground ] ) ) { // do this only ONCE per script, for each unique colour.
			$f                         = array(
				'r' => hexdec( $foreground[0] . $foreground[1] ),
				'g' => hexdec( $foreground[2] . $foreground[3] ),
				'b' => hexdec( $foreground[4] . $foreground[5] ),
			);
			$colors_rgb[ $foreground ] = $f;
		} else { // if this function is used 100 times in a script, this block is run 99 times.  Efficient.
			$f = $colors_rgb[ $foreground ];
		}

		if ( ! isset( $colors_rgb[ $background ] ) ) { // do this only ONCE per script, for each unique colour.
			$b                         = array(
				'r' => hexdec( $background[0] . $background[1] ),
				'g' => hexdec( $background[2] . $background[3] ),
				'b' => hexdec( $background[4] . $background[5] ),
			);
			$colors_rgb[ $background ] = $b;
		} else { // if this FUNCTION is used 100 times in a SCRIPT, this block will run 99 times.  Efficient.
			$b = $colors_rgb[ $background ];
		}

		$add = array(
			'r' => ( $b['r'] - $f['r'] ) / 100,
			'g' => ( $b['g'] - $f['g'] ) / 100,
			'b' => ( $b['b'] - $f['b'] ) / 100,
		);

		$f['r'] += intval( $add['r'] * $transparency );
		$f['g'] += intval( $add['g'] * $transparency );
		$f['b'] += intval( $add['b'] * $transparency );

		return sprintf( '#%02X%02X%02X', $f['r'], $f['g'], $f['b'] );
	}

	/**
	 * Add Theme Options for the Customizer.
	 *
	 * @param WP_Customize_Manager $wp_customize Theme Customizer object.
	 */
	function seedlet_customize_custom_colors_register( $wp_customize ) {

		/**
		 * Create color options panel.
		 */
		$wp_customize->add_section(
			'seedlet_options',
			array(
				'capability' => 'edit_theme_options',
				'title'      => esc_html__( 'Colors', 'seedlet' ),
			)
		);

		/**
		 * Create toggle between default and custom colors.
		 */
		$wp_customize->add_setting(
			'custom_colors_active',
			array(
				'capability'        => 'edit_theme_options',
				'sanitize_callback' => array( $this, 'sanitize_select' ),
				'transport'         => 'refresh',
				'default'           => 'default',
			)
		);

		$wp_customize->add_control(
			'custom_colors_active',
			array(
				'type'    => 'radio',
				'section' => 'seedlet_options',
				'label'   => __( 'Colors', 'seedlet' ),
				'choices' => array(
					'default' => __( 'Theme Default', 'seedlet' ),
					'custom'  => __( 'Custom', 'seedlet' ),
				),
			)
		);

		/**
		 * Create customizer color controls.
		 */
		foreach ( $this->seedlet_custom_color_variables as $variable ) {
			$wp_customize->add_setting(
				"seedlet_$variable[0]",
				array(
					'default'           => esc_html( $variable[1] ),
					'sanitize_callback' => 'sanitize_hex_color',
				)
			);
			$wp_customize->add_control(
				new WP_Customize_Color_Control(
					$wp_customize,
					"seedlet_$variable[0]",
					array(
						'section'         => 'seedlet_options',
						'label'           => $variable[2],
						'active_callback' => function() use ( $wp_customize ) {
							return ( 'custom' === $wp_customize->get_setting( 'custom_colors_active' )->value() );
						},
					)
				)
			);
		}
	}

	/**
	 * Generate color variables.
	 */
	function seedlet_generate_custom_color_variables( $context = null ) {

		if ( $context === 'editor' ) {
			$theme_css = ':root .editor-styles-wrapper {';
		} else {
			$theme_css = ':root {';
		}

		// Check to see if a custom background color has been set that is needed for our color calculation
		// If this check isn't present, the color calculation generates a warning that an invalid color has been supplied
		$theme_mod_bg_color = empty( get_theme_mod( 'seedlet_--global--color-background' ) ) ? '#FFFFFF' : get_theme_mod( 'seedlet_--global--color-background' );

		foreach ( $this->seedlet_custom_color_variables as $variable ) {

			if ( ! empty( get_theme_mod( "seedlet_$variable[0]" ) ) ) {

				$theme_mod_variable_name = $variable[0];
				$theme_mod_default_color = $variable[1];
				$theme_mod_custom_color  = get_theme_mod( "seedlet_$variable[0]" );
				$opacity_integer         = 70;
				$adjusted_color          = $this->seedlet_color_blend_by_opacity( $theme_mod_custom_color, $opacity_integer, $theme_mod_bg_color );

				$theme_css .= $theme_mod_variable_name . ':' . $theme_mod_custom_color . ';';

				if ( $theme_mod_variable_name === '--global--color-primary' && $theme_mod_default_color !== $theme_mod_custom_color ) {
					$theme_css .= '--global--color-primary-hover: ' . $adjusted_color . ';';
				}

				if ( $theme_mod_variable_name === '--global--color-secondary' && $theme_mod_default_color !== $theme_mod_custom_color ) {
					$theme_css .= '--global--color-secondary-hover: ' . $adjusted_color . ';';
				}

				if ( $theme_mod_variable_name === '--global--color-foreground' && $theme_mod_default_color !== $theme_mod_custom_color ) {
					$theme_css .= '--global--color-foreground-low-contrast: ' . $adjusted_color . ';';
				}

				if ( $theme_mod_variable_name === '--global--color-background' && $theme_mod_default_color !== $theme_mod_custom_color ) {
					$theme_css .= '--global--color-background-high-contrast:' . $theme_mod_custom_color . ';';
				}
			}
		}

		$theme_css .= '}';

		// Text selection colors
		$selection_background = $this->seedlet_color_blend_by_opacity( get_theme_mod( 'seedlet_--global--color-primary' ), 5, $theme_mod_bg_color ) . ';';
		$theme_css           .= '::selection { background-color: ' . $selection_background . '}';
		$theme_css           .= '::-moz-selection { background-color: ' . $selection_background . '}';

		return $theme_css;
	}

	/**
	 * Customizer & frontend custom color variables.
	 */
	function seedlet_custom_color_variables() {
		wp_enqueue_style( 'seedlet-custom-color-overrides', get_template_directory_uri() . '/assets/css/custom-color-overrides.css', array(), wp_get_theme()->get( 'Version' ) );
		if ( 'default' !== get_theme_mod( 'custom_colors_active' ) ) {
			wp_add_inline_style( 'seedlet-custom-color-overrides', $this->seedlet_generate_custom_color_variables() );
		}
	}

	/**
	 * Editor custom color variables.
	 */
	function seedlet_editor_custom_color_variables() {
		wp_enqueue_style( 'seedlet-custom-color-overrides', get_template_directory_uri() . '/assets/css/custom-color-overrides.css', array(), wp_get_theme()->get( 'Version' ) );
		if ( 'default' !== get_theme_mod( 'custom_colors_active' ) ) {
			wp_add_inline_style( 'seedlet-custom-color-overrides', $this->seedlet_generate_custom_color_variables( 'editor' ) );
		}
	}

	/**
	 * Customizer contrast validation warnings.
	 *
	 * @author Per Soderlind
	 * @link https://github.com/soderlind/2016-customizer-demo
	 */
	function on_customize_controls_enqueue_scripts() {
		$handle = 'seedlet-wcag-validate-customizer-color-contrast';
		$src    = get_template_directory_uri() . '/assets/js/customizer-validate-wcag-color-contrast.js';
		$deps   = array( 'customize-controls' );

		$exports = array(
			'validate_color_contrast' => array(
				// key = current color control , values = array with color controls to check color contrast against
				'seedlet_--global--color-primary'    => array( 'seedlet_--global--color-background' ),
				'seedlet_--global--color-secondary'  => array( 'seedlet_--global--color-background' ),
				'seedlet_--global--color-foreground' => array( 'seedlet_--global--color-background' ),
				'seedlet_--global--color-background' => array( 'seedlet_--global--color-foreground' ),
			),
		);

		wp_enqueue_script( $handle, $src, $deps );
		wp_script_add_data( $handle, 'data', sprintf( 'var seedletValidateWCAGColorContrastExports = %s;', wp_json_encode( $exports ) ) );

		// Custom color contrast validation text
		wp_localize_script( $handle, 'seedletValidateContrastText', array( esc_html__( 'This color combination may be hard for people to read. Try using a brighter background color and/or a darker foreground color.', 'seedlet' ) ) );
	}

	/**
	 * Sanitize select.
	 *
	 * @param string $input The input from the setting.
	 * @param object $setting The selected setting.
	 *
	 * @return string $input|$setting->default The input from the setting or the default setting.
	 */
	public static function sanitize_select( $input, $setting ) {
		$input   = sanitize_key( $input );
		$choices = $setting->manager->get_control( $setting->id )->choices;
		return ( array_key_exists( $input, $choices ) ? $input : $setting->default );
	}

}

new Seedlet_Custom_Colors;