WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
03/04/2014 08:20:28 PM (13 years ago)
Author:
nacin
Message:

Update the Customizer API inline docs.

props ericlewis.
fixes #27065.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-wp-customize-section.php

    r26892 r27398  
    22/**
    33 * Customize Section Class.
     4 *
     5 * A UI container for controls, managed by the WP_Customize_Manager.
    46 *
    57 * @package WordPress
    … …  
    810 */
    911class WP_Customize_Section {
     12        /**
     13         * @access public
     14         *
     15         * @var WP_Customize_Manager
     16         */
    1017        public $manager;
     18
     19        /**
     20         * Unique identifier.
     21         *
     22         * @var string
     23         */
    1124        public $id;
     25
     26        /**
     27         * Priority of the section which informs load order of sections.
     28         *
     29         * @var integer
     30         */
    1231        public $priority       = 10;
     32
     33        /**
     34         * Capability required for the section.
     35         *
     36         * @var string
     37         */
    1338        public $capability     = 'edit_theme_options';
    1439        public $theme_supports = '';
     40
     41        /**
     42         * Title of the section to show in UI.
     43         *
     44         * @var string
     45         */
    1546        public $title          = '';
     47
     48        /**
     49         * Description to show in the UI.
     50         *
     51         * @var string
     52         */
    1653        public $description    = '';
    1754        public $controls;
    … …  
    2057         * Constructor.
    2158         *
     59         * Any supplied $args override class property defaults.
     60         *
    2261         * @since 3.4.0
    2362         *
    2463         * @param WP_Customize_Manager $manager
    25          * @param string $id An specific ID of the section.
    26          * @param array $args Section arguments.
     64         * @param string               $id      An specific ID of the section.
     65         * @param array                $args    Section arguments.
    2766         */
    2867        function __construct( $manager, $id, $args = array() ) {
    … …  
    4281
    4382        /**
    44          * Check if the theme supports the section and check user capabilities.
     83         * Checks required user capabilities and whether the theme has the
     84         * feature support required by the section.
    4585         *
    4686         * @since 3.4.0
    … …  
    72112                 * @since 3.4.0
    73113                 *
    74                  * @param WP_Customize_Section $this The WP_Customize_Section instance.
     114                 * @param WP_Customize_Section $this WP_Customize_Section instance.
    75115                 */
    76116                do_action( 'customize_render_section', $this );
    … …  
    89129
    90130        /**
    91          * Render the section.
     131         * Render the section, and the controls that have been added to it.
    92132         *
    93133         * @since 3.4.0
Note: See TracChangeset for help on using the changeset viewer.