WP_Widget_Area_Customize_Control
- Since
- 3.9.0
- Source
wp-includes/customize/class-wp-widget-area-customize-control.php:17
Widget Area Customize Control class.
Compatibility
- WordPress
- since 3.9.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).
Properties · 2
$typestringpublic- Customize control type.
$sidebar_idint|stringpublic- Sidebar ID.
Methods · 2
- to_json()Refreshes the parameters passed to the JavaScript via JSON.
- render_content()Renders the control's content.
Source code
class WP_Widget_Area_Customize_Control extends WP_Customize_Control { /** * Customize control type. * * @since 3.9.0 * @var string */ public $type = 'sidebar_widgets'; /** * Sidebar ID. * * @since 3.9.0 * @var int|string */ public $sidebar_id; /** * Refreshes the parameters passed to the JavaScript via JSON. * * @since 3.9.0 */ public function to_json() { parent::to_json(); $exported_properties = array( 'sidebar_id' ); foreach ( $exported_properties as $key ) { $this->json[ $key ] = $this->$key; } } /** * Renders the control's content. * * @since 3.9.0 */ public function render_content() { $id = 'reorder-widgets-desc-' . str_replace( array( '[', ']' ), array( '-', '' ), $this->id ); ?> <button type="button" class="button add-new-widget" aria-expanded="false" aria-controls="available-widgets"> <?php _e( 'Add a Widget' ); ?> </button> <button type="button" class="button-link reorder-toggle" aria-label="<?php esc_attr_e( 'Reorder widgets' ); ?>" aria-describedby="<?php echo esc_attr( $id ); ?>"> <span class="reorder"><?php _e( 'Reorder' ); ?></span> <span class="reorder-done"><?php _e( 'Done' ); ?></span> </button> <p class="screen-reader-text" id="<?php echo esc_attr( $id ); ?>"> <?php /* translators: Hidden accessibility text. */ _e( 'When in reorder mode, additional controls to reorder widgets will be available in the widgets list above.' ); ?> </p> <?php }}Changelog
Introduced in 3.9.0. Unchanged from 6.7.7 through 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-widget-area-customize-control.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.