PHPXRef 0.7.1 : WordPress : Detail view of class-wp-customize-custom-css-setting.php

Customize API: WP_Customize_Custom_CSS_Setting class This handles validation, sanitization and saving of the value.

File Size:	212 lines (5 kb)
Included or required:	1 time
Referenced:	0 times
Includes or requires:	0 files

Defines 6 functions

  __construct()
  preview()
  filter_previewed_wp_get_custom_css()
  value()
  validate()
  update()

Functions

Functions that are not part of a class:

__construct( $manager, $id, $args = array() X-Ref

WP_Customize_Custom_CSS_Setting constructor.

since: 4.7.0
param: WP_Customize_Manager $manager Customizer bootstrap instance.
param: string $id A specific ID of the setting.
param: array $args Setting arguments.

preview() X-Ref

Add filter to preview post value.

since: 4.7.9
return: bool False when preview short-circuits due no change needing to be previewed.

filter_previewed_wp_get_custom_css( $css, $stylesheet ) X-Ref

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
return: string CSS.
param: string $css Original CSS.
param: string $stylesheet Current stylesheet.

value() X-Ref

Fetch the value of the setting. Will return the previewed value when `preview()` is called.

since: 4.7.0
return: string

validate( $value ) X-Ref

Validate a received value for being valid CSS.

Checks for imbalanced braces, brackets, and comments.
Notifications are rendered when the customizer state is saved.

since: 4.7.0
since: 4.9.0 Checking for balanced characters has been moved client-side via linting in code editor.
since: 5.9.0 Renamed `$css` to `$value` for PHP 8 named parameter support.
return: true|WP_Error True if the input was validated, otherwise WP_Error.
param: string $value CSS to validate.

update( $value ) X-Ref

Store the CSS setting value in the custom_css custom post type for the stylesheet.

since: 4.7.0
since: 5.9.0 Renamed `$css` to `$value` for PHP 8 named parameter support.
return: int|false The post ID or false if the value could not be saved.
param: string $value CSS to update.

PHP Cross Reference of WordPress

/wp-includes/customize/ -> class-wp-customize-custom-css-setting.php (summary)

Defines 6 functions