WP_Customize_Panel::__construct() WordPress Method

The WP_Customize_Panel::__construct() method is used to create a new panel for the customizer. This panel will contain sections and settings.

WP_Customize_Panel::__construct( WP_Customize_Manager $manager, string $id, array $args = array() ) #

Constructor.


Description

Any supplied $args override class property defaults.


Top ↑

Parameters

$manager

(WP_Customize_Manager)(Required)Customizer bootstrap instance.

$id

(string)(Required)A specific ID for the panel.

$args

(array)(Optional)Array of properties for the new Panel object.

  • 'priority'
    (int) Priority of the panel, defining the display order of panels and sections. Default 160.
  • 'capability'
    (string) Capability required for the panel. Default edit_theme_options.
  • 'theme_supports'
    (string|string[]) Theme features required to support the panel.
  • 'title'
    (string) Title of the panel to show in UI.
  • 'description'
    (string) Description to show in the UI.
  • 'type'
    (string) Type of the panel.
  • 'active_callback'
    (callable) Active callback.

Default value: array()


Top ↑

Source

File: wp-includes/class-wp-customize-panel.php

	public function __construct( $manager, $id, $args = array() ) {
		$keys = array_keys( get_object_vars( $this ) );
		foreach ( $keys as $key ) {
			if ( isset( $args[ $key ] ) ) {
				$this->$key = $args[ $key ];
			}
		}

		$this->manager = $manager;
		$this->id      = $id;
		if ( empty( $this->active_callback ) ) {
			$this->active_callback = array( $this, 'active_callback' );
		}
		self::$instance_count += 1;
		$this->instance_number = self::$instance_count;

		$this->sections = array(); // Users cannot customize the $sections array.
	}


Top ↑

Changelog

Changelog
VersionDescription
4.0.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.