Widget_Sidebar()
Elementor sidebar widget.
Description
Elementor widget that insert any sidebar into the page.
Changelog
Version | Description |
---|---|
1.0.0 | Introduced. |
Methods
- _content_template — Render sidebar widget output in the editor.
- _register_controls — Register sidebar widget controls.
- get_categories — Get widget categories.
- get_icon — Get widget icon.
- get_keywords — Get widget keywords.
- get_name — Get widget name.
- get_title — Get widget title.
- render — Render sidebar widget output on the frontend.
- render_plain_content — Render sidebar widget as plain content.
Source
includes/widgets/sidebar.php
class Widget_Sidebar extends Widget_Base { /** * Get widget name. * * Retrieve sidebar widget name. * * @since 1.0.0 * @access public * * @return string Widget name. */ public function get_name() { return 'sidebar'; } /** * Get widget title. * * Retrieve sidebar widget title. * * @since 1.0.0 * @access public * * @return string Widget title. */ public function get_title() { return __( 'Sidebar', 'elementor' ); } /** * Get widget icon. * * Retrieve sidebar widget icon. * * @since 1.0.0 * @access public * * @return string Widget icon. */ public function get_icon() { return 'eicon-sidebar'; } /** * Get widget categories. * * Retrieve the list of categories the sidebar widget belongs to. * * Used to determine where to display the widget in the editor. * * @since 1.0.0 * @access public * * @return array Widget categories. */ public function get_categories() { return [ 'general-elements' ]; } /** * Register sidebar widget controls. * * Adds different input fields to allow the user to change and customize the widget settings. * * @since 1.0.0 * @access protected */ protected function _register_controls() { global $wp_registered_sidebars; $options = []; if ( ! $wp_registered_sidebars ) { $options[''] = __( 'No sidebars were found', 'elementor' ); } else { $options[''] = __( 'Choose Sidebar', 'elementor' ); foreach ( $wp_registered_sidebars as $sidebar_id => $sidebar ) { $options[ $sidebar_id ] = $sidebar['name']; } } $default_key = array_keys( $options ); $default_key = array_shift( $default_key ); $this->start_controls_section( 'section_sidebar', [ 'label' => __( 'Sidebar', 'elementor' ), ] ); $this->add_control( 'sidebar', [ 'label' => __( 'Choose Sidebar', 'elementor' ), 'type' => Controls_Manager::SELECT, 'default' => $default_key, 'options' => $options, ] ); $this->end_controls_section(); } /** * Render sidebar widget output on the frontend. * * Written in PHP and used to generate the final HTML. * * @since 1.0.0 * @access protected */ protected function render() { $sidebar = $this->get_settings( 'sidebar' ); if ( empty( $sidebar ) ) { return; } dynamic_sidebar( $sidebar ); } /** * Render sidebar widget output in the editor. * * Written as a Backbone JavaScript template and used to generate the live preview. * * @since 1.0.0 * @access protected */ protected function _content_template() {} /** * Render sidebar widget as plain content. * * Override the default render behavior, don't render sidebar content. * * @since 1.0.0 * @access public */ public function render_plain_content() {} }