| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
WordPress Customize Section classes
| File Size: | 402 lines (11 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 3 files wp-includes/customize/class-wp-customize-nav-menu-section.php wp-includes/customize/class-wp-customize-sidebar-section.php wp-includes/customize/class-wp-customize-themes-section.php |
WP_Customize_Section:: (10 methods):
__construct()
active()
active_callback()
json()
check_capabilities()
get_content()
maybe_render()
render()
print_template()
render_template()
Class: WP_Customize_Section - X-Ref
Customize Section class.| __construct( $manager, $id, $args = array() X-Ref |
| Constructor. 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 { since: 3.4.0 |
| active() X-Ref |
| Check whether section is active to current Customizer preview. return: bool Whether the section is active to the current preview. since: 4.1.0 |
| 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. since: 4.1.0 |
| json() X-Ref |
| Gather the parameters passed to client JavaScript via JSON. return: array The array to be exported to the client as JSON. since: 4.1.0 |
| 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. since: 3.4.0 |
| get_content() X-Ref |
| Get the section's content for insertion into the Customizer pane. return: string Contents of the section. since: 4.1.0 |
| maybe_render() X-Ref |
| Check capabilities and render the section. since: 3.4.0 |
| render() X-Ref |
| Render the section UI in a subclass. Sections are now rendered in JS by default, see WP_Customize_Section::print_template(). since: 3.4.0 |
| print_template() X-Ref |
| Render the section's JS template. This function is only run for section types that have been registered with WP_Customize_Manager::register_section_type(). since: 4.3.0 |
| 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(). since: 4.3.0 |
| Generated: Sun Dec 22 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |