sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Add a reference to WP_Customize_Panel::__construct() for information on accepted arguments in WP_Customize_Manager::add_panel().

Browse Source 
Synchronize the documentation between two places, use `WP_Customize_Panel::__construct()` as the canonical source.

Props iaaxpage, marekdedic.
Fixes #48344.

git-svn-id: https://develop.svn.wordpress.org/trunk@47387 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-02-27 20:34:49 +00:00
parent 19bdff7326
commit ef613db765
2 changed files with 19 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/wp-includes/class-wp-customize-manager.php
View File

@ -3801,20 +3801,12 @@ final class WP_Customize_Manager {
* @since 4.0.0
* @since 4.5.0 Return added WP_Customize_Panel instance.
*
* @param WP_Customize_Panel|string $id Customize Panel object, or Panel ID.
* @param array $args {
* Optional. Array of properties for the new Panel object. Default empty array.
* @see WP_Customize_Panel::__construct()
*
* @type int $priority Priority of the panel, defining the display order
* of panels and sections. Default 160.
* @type string $capability Capability required for the panel.
* Default `edit_theme_options`.
* @type string|string[] $theme_supports Theme features required to support the panel.
* @type string $title Title of the panel to show in UI.
* @type string $description Description to show in the UI.
* @type string $type Type of the panel.
* @type callable $active_callback Active callback.
* }
* @param WP_Customize_Panel|string $id Customize Panel object, or ID.
* @param array $args Optional. Array of properties for the new Panel object.
* See WP_Customize_Panel::__construct() for information
* on accepted arguments. Default empty array.
* @return WP_Customize_Panel The instance of the panel that was added.
*/
public function add_panel( $id, $args = array() ) {
@ -3901,7 +3893,7 @@ final class WP_Customize_Manager {
*
* @see WP_Customize_Section::__construct()
*
* @param WP_Customize_Section|string $id Customize Section object, or Section ID.
* @param WP_Customize_Section|string $id Customize Section object, or ID.
* @param array $args Optional. Array of properties for the new Section object.
* See WP_Customize_Section::__construct() for information
* on accepted arguments. Default empty array.

14
src/wp-includes/class-wp-customize-panel.php
View File

@ -139,7 +139,19 @@ class WP_Customize_Panel {
*
* @param WP_Customize_Manager $manager Customizer bootstrap instance.
* @param string $id A specific ID for the panel.
* @param array $args Panel arguments.
* @param array $args {
* Optional. Array of properties for the new Panel object. Default empty array.
*
* @type int $priority Priority of the panel, defining the display order
* of panels and sections. Default 160.
* @type string $capability Capability required for the panel.
* Default `edit_theme_options`.
* @type string|string[] $theme_supports Theme features required to support the panel.
* @type string $title Title of the panel to show in UI.
* @type string $description Description to show in the UI.
* @type string $type Type of the panel.
* @type callable $active_callback Active callback.
* }
*/
public function __construct( $manager, $id, $args = array() ) {
$keys = array_keys( get_object_vars( $this ) );