wppaste
WordPress

WP_Customize_Custom_CSS_Setting

Since
4.7.0
Source
wp-includes/customize/class-wp-customize-custom-css-setting.php:19
Custom Setting to handle WP Custom CSS.

Compatibility

WordPress
since 4.7.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 1

Every hook that fires from inside WP_Customize_Custom_CSS_Setting, in the order it appears in the class, grouped by the method that fires it.

Properties · 4

$typestringpublic
The setting type.
$transportstringpublic
Setting Transport
$capabilitystringpublic
Capability required to edit this setting.
$stylesheetstringpublic
Stylesheet

Methods · 6

  • __construct()WP_Customize_Custom_CSS_Setting constructor.
  • preview()Add filter to preview post value.
  • filter_previewed_wp_get_custom_css()Filters `wp_get_custom_css` for applying the customized value.
  • value()Fetch the value of the setting. Will return the previewed value when `preview()` is called.
  • validate()Validate a received value for being valid CSS.
  • update()Store the CSS setting value in the custom_css custom post type for the stylesheet.

Source code

final class WP_Customize_Custom_CSS_Setting extends WP_Customize_Setting { 	/**	 * The setting type.	 *	 * @since 4.7.0	 * @var string	 */	public $type = 'custom_css'; 	/**	 * Setting Transport	 *	 * @since 4.7.0	 * @var string	 */	public $transport = 'postMessage'; 	/**	 * Capability required to edit this setting.	 *	 * @since 4.7.0	 * @var string	 */	public $capability = 'edit_css'; 	/**	 * Stylesheet	 *	 * @since 4.7.0	 * @var string	 */	public $stylesheet = ''; 	/**	 * WP_Customize_Custom_CSS_Setting constructor.	 *	 * @since 4.7.0	 *	 * @throws Exception If the setting ID does not match the pattern `custom_css[$stylesheet]`.	 *	 * @param WP_Customize_Manager $manager Customizer bootstrap instance.	 * @param string               $id      A specific ID of the setting.	 *                                      Can be a theme mod or option name.	 * @param array                $args    Setting arguments.	 */	public function __construct( $manager, $id, $args = array() ) {		parent::__construct( $manager, $id, $args );		if ( 'custom_css' !== $this->id_data['base'] ) {			throw new Exception( 'Expected custom_css id_base.' );		}		if ( 1 !== count( $this->id_data['keys'] ) || empty( $this->id_data['keys'][0] ) ) {			throw new Exception( 'Expected single stylesheet key.' );		}		$this->stylesheet = $this->id_data['keys'][0];	} 	/**	 * Add filter to preview post value.	 *	 * @since 4.7.9	 *	 * @return bool False when preview short-circuits due no change needing to be previewed.	 */	public function preview() {		if ( $this->is_previewed ) {			return false;		}		$this->is_previewed = true;		add_filter( 'wp_get_custom_css', array( $this, 'filter_previewed_wp_get_custom_css' ), 9, 2 );		return true;	} 	/**	 * Filters `wp_get_custom_css` for applying the customized value.	 *	 * This is used in the preview when `wp_get_custom_css()` is called for rendering the styles.	 *	 * @since 4.7.0	 *

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/customize/class-wp-customize-custom-css-setting.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.