WordPress Cross Reference

Functions that are not part of a class:

Constructor.

Return true if it's an AJAX request.

return: bool

wp_die( $ajax_message, $message = null ) X-Ref

Custom wp_die wrapper. Returns either the standard message for UI
or the AJAX message.

param: mixed $ajax_message AJAX return
param: mixed $message UI message

wp_die_handler() X-Ref

Return the AJAX wp_die() handler if it's a customized request.

return: string

setup_theme() X-Ref

Start preview and customize theme.

Check if customize query variable exist. Init filters to filter the current theme.

after_setup_theme() X-Ref

Callback to validate a theme once it is loaded

start_previewing_theme() X-Ref

Start previewing the selected theme.

Adds filters to change the current theme.

stop_previewing_theme() X-Ref

Stop previewing the selected theme.

Removes filters to change the current theme.

theme() X-Ref

Get the theme being customized.

return: WP_Theme

settings() X-Ref

Get the registered settings.

return: array

controls() X-Ref

Get the registered controls.

return: array

sections() X-Ref

Get the registered sections.

return: array

is_theme_active() X-Ref

Checks if the current theme is active.

return: bool

wp_loaded() X-Ref

Register styles/scripts and initialize the preview of each setting

wp_redirect_status( $status ) X-Ref

Prevents AJAX requests from following redirects when previewing a theme
by issuing a 200 response instead of a 30x.

Instead, the JS will sniff out the location header.

param: $status
return: int

post_value( $setting ) X-Ref

Decode the $_POST attribute used to override the WP_Customize_Setting values.

param: mixed $setting A WP_Customize_Setting derived object
return: string Sanitized attribute

customize_preview_init() X-Ref

Print javascript settings.

customize_preview_base() X-Ref

Print base element for preview frame.

customize_preview_html5() X-Ref

Print a workaround to handle HTML5 tags in IE < 9

customize_preview_settings() X-Ref

Print javascript settings for preview frame.

customize_preview_signature() X-Ref

Prints a signature so we can ensure the customizer was properly executed.

remove_preview_signature( $return = null ) X-Ref

Removes the signature in case we experience a case where the customizer was not properly executed.

is_preview() X-Ref

Is it a theme preview?

return: bool True if it's a preview, false if not.

get_template() X-Ref

Retrieve the template name of the previewed theme.

return: string Template name.

get_stylesheet() X-Ref

Retrieve the stylesheet name of the previewed theme.

return: string Stylesheet name.

get_template_root() X-Ref

Retrieve the template root of the previewed theme.

return: string Theme root.

get_stylesheet_root() X-Ref

Retrieve the stylesheet root of the previewed theme.

return: string Theme root.

current_theme( $current_theme ) X-Ref

Filter the current theme and return the name of the previewed theme.

param: $current_theme {@internal Parameter is not used}
return: string Theme name.

save() X-Ref

Switch the theme and trigger the save action of each setting.

add_setting( $id, $args = array() X-Ref

Add a customize setting.

param: string $id A specific ID of the setting. Can be a
param: array $args Setting arguments.

get_setting( $id ) X-Ref

Retrieve a customize setting.

param: string $id A specific ID of the setting.
return: object The settings object.

remove_setting( $id ) X-Ref

Remove a customize setting.

param: string $id A specific ID of the setting.

add_section( $id, $args = array() X-Ref

Add a customize section.

param: string $id A specific ID of the section.
param: array $args Section arguments.

get_section( $id ) X-Ref

Retrieve a customize section.

param: string $id A specific ID of the section.
return: object The section object.

remove_section( $id ) X-Ref

Remove a customize section.

param: string $id A specific ID of the section.

add_control( $id, $args = array() X-Ref

Add a customize control.

param: string $id A specific ID of the control.
param: array $args Setting arguments.

get_control( $id ) X-Ref

Retrieve a customize control.

param: string $id A specific ID of the control.
return: object The settings object.

remove_control( $id ) X-Ref

Remove a customize setting.

param: string $id A specific ID of the control.

_cmp_priority( $a, $b ) X-Ref

Helper function to compare two objects by priority.

param: object $a Object A.
param: object $b Object B.
return: int

prepare_controls() X-Ref

Prepare settings and sections.

enqueue_control_scripts() X-Ref

Enqueue scripts for customize controls.

register_controls() X-Ref

Register some default controls.

_sanitize_header_textcolor( $color ) X-Ref

Callback for validating the header_textcolor value.

Accepts 'blank', and otherwise uses sanitize_hex_color_no_hash().
Returns default text color if hex color is empty.

param: string $color
return: string

sanitize_hex_color( $color ) X-Ref

Validates a hex color.

Returns either '', a 3 or 6 digit hex color (with #), or null.
For validating values without a #, see sanitize_hex_color_no_hash().

param: string $color
return: string|null

sanitize_hex_color_no_hash( $color ) X-Ref

Sanitizes a hex color without a hash. Use sanitize_hex_color() when possible.

Saving hex colors without a hash puts the burden of adding the hash on the
UI, which makes it difficult to use or upgrade to other color types such as
rgba, hsl, rgb, and html color names.

Returns either '', a 3 or 6 digit hex color (without a #), or null.

param: string $color
return: string|null

maybe_hash_hex_color( $color ) X-Ref

Ensures that any hex color is properly hashed.
Otherwise, returns value untouched.

This method should only be necessary if using sanitize_hex_color_no_hash().

param: string $color
return: string

File Size:	1059 lines (27 kb)
Included or required:	1 time
Referenced:	0 times
Includes or requires:	3 files wp-includes/class-wp-customize-setting.php wp-includes/class-wp-customize-section.php wp-includes/class-wp-customize-control.php

/wp-includes/ -> class-wp-customize-manager.php (summary)

Defines 46 functions