[ Index ]

WordPress 5.4.1

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]     [ Statistics ]    




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

WordPress Customize Section classes

File Size: 402 lines (11 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 3 files

Defines 1 class

WP_Customize_Section:: (10 methods):

Class: WP_Customize_Section  - X-Ref

Customize Section class.

A UI container for controls, managed by the WP_Customize_Manager class.

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

Any supplied $args override class property defaults.

param: WP_Customize_Manager $manager Customizer bootstrap instance.
param: string               $id      A specific ID of the section.
param: array                $args    {

active()   X-Ref
Check whether section is active to current Customizer preview.

return: bool Whether the section is active to the current preview.

active_callback()   X-Ref
Default callback used when invoking WP_Customize_Section::active().

Subclasses can override this with their specific logic, or they may provide
an 'active_callback' argument to the constructor.

return: true Always true.

json()   X-Ref
Gather the parameters passed to client JavaScript via JSON.

return: array The array to be exported to the client as JSON.

check_capabilities()   X-Ref
Checks required user capabilities and whether the theme has the
feature support required by the section.

return: bool False if theme doesn't support the section or user doesn't have the capability.

get_content()   X-Ref
Get the section's content for insertion into the Customizer pane.

return: string Contents of the section.

maybe_render()   X-Ref
Check capabilities and render the section.

render()   X-Ref
Render the section UI in a subclass.

Sections are now rendered in JS by default, see WP_Customize_Section::print_template().

print_template()   X-Ref
Render the section's JS template.

This function is only run for section types that have been registered with

render_template()   X-Ref
An Underscore (JS) template for rendering this section.

Class variables for this section class are available in the `data` JS object;
export custom variables by overriding WP_Customize_Section::json().

Generated: Tue May 19 15:51:04 2020 Cross-referenced by PHPXref 0.7.1