WP_Customize_Sidebar_Section WordPress Class

The WP_Customize_Sidebar_Section class allows you to add a custom sidebar to your WordPress site. You can use this sidebar to display widgets, custom menus, or any other content you want.

WP_Customize_Sidebar_Section #

Customizer section representing widget area (sidebar).


Description

Top ↑

See also


Top ↑

Source

File: wp-includes/customize/class-wp-customize-sidebar-section.php

class WP_Customize_Sidebar_Section extends WP_Customize_Section {

	/**
	 * Type of this section.
	 *
	 * @since 4.1.0
	 * @var string
	 */
	public $type = 'sidebar';

	/**
	 * Unique identifier.
	 *
	 * @since 4.1.0
	 * @var string
	 */
	public $sidebar_id;

	/**
	 * Gather the parameters passed to client JavaScript via JSON.
	 *
	 * @since 4.1.0
	 *
	 * @return array The array to be exported to the client as JSON.
	 */
	public function json() {
		$json              = parent::json();
		$json['sidebarId'] = $this->sidebar_id;
		return $json;
	}

	/**
	 * Whether the current sidebar is rendered on the page.
	 *
	 * @since 4.1.0
	 *
	 * @return bool Whether sidebar is rendered.
	 */
	public function active_callback() {
		return $this->manager->widgets->is_sidebar_rendered( $this->sidebar_id );
	}
}


Top ↑

Methods

  • active_callback— Whether the current sidebar is rendered on the page.
  • json— Gather the parameters passed to client JavaScript via JSON.

Top ↑

Changelog

Changelog
VersionDescription
4.1.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.