Improve some inline documentation for class properties in WP_Customize_Section.

Props leewillis77 for the initial patch.
Fixes #26245.

Built from https://develop.svn.wordpress.org/trunk@27902


git-svn-id: http://core.svn.wordpress.org/trunk@27733 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-04-02 03:02:16 +00:00
parent 668235fb42
commit 3d2728f7a6

View File

@ -9,9 +9,12 @@
* @since 3.4.0 * @since 3.4.0
*/ */
class WP_Customize_Section { class WP_Customize_Section {
/** /**
* @access public * WP_Customize_Manager instance.
* *
* @since 3.4.0
* @access public
* @var WP_Customize_Manager * @var WP_Customize_Manager
*/ */
public $manager; public $manager;
@ -19,6 +22,8 @@ class WP_Customize_Section {
/** /**
* Unique identifier. * Unique identifier.
* *
* @since 3.4.0
* @access public
* @var string * @var string
*/ */
public $id; public $id;
@ -26,6 +31,8 @@ class WP_Customize_Section {
/** /**
* Priority of the section which informs load order of sections. * Priority of the section which informs load order of sections.
* *
* @since 3.4.0
* @access public
* @var integer * @var integer
*/ */
public $priority = 10; public $priority = 10;
@ -33,14 +40,26 @@ class WP_Customize_Section {
/** /**
* Capability required for the section. * Capability required for the section.
* *
* @since 3.4.0
* @access public
* @var string * @var string
*/ */
public $capability = 'edit_theme_options'; public $capability = 'edit_theme_options';
/**
* Theme feature support for the section.
*
* @since 3.4.0
* @access public
* @var string|array
*/
public $theme_supports = ''; public $theme_supports = '';
/** /**
* Title of the section to show in UI. * Title of the section to show in UI.
* *
* @since 3.4.0
* @access public
* @var string * @var string
*/ */
public $title = ''; public $title = '';
@ -48,9 +67,19 @@ class WP_Customize_Section {
/** /**
* Description to show in the UI. * Description to show in the UI.
* *
* @since 3.4.0
* @access public
* @var string * @var string
*/ */
public $description = ''; public $description = '';
/**
* Customizer controls for this section.
*
* @since 3.4.0
* @access public
* @var array
*/
public $controls; public $controls;
/** /**
@ -60,7 +89,7 @@ class WP_Customize_Section {
* *
* @since 3.4.0 * @since 3.4.0
* *
* @param WP_Customize_Manager $manager * @param WP_Customize_Manager $manager Customizer bootstrap instance.
* @param string $id An specific ID of the section. * @param string $id An specific ID of the section.
* @param array $args Section arguments. * @param array $args Section arguments.
*/ */