WordPress.org

Make WordPress Core

Ticket #26196: 26196.diff

File 26196.diff, 2.7 KB (added by leewillis77, 8 years ago)

Hook docs patch

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

     
    11<?php
    22/**
     3 * The WP_Customize_Section class
     4 *
     5 * This class represents a section within the Customizer
     6 *
     7 * @since 3.4.0
     8 *
     9 * @package WordPress
     10 * @subpackage Customize
     11 */
     12
     13/**
    314 * Customize Section Class.
    415 *
    516 * @package WordPress
     
    718 * @since 3.4.0
    819 */
    920class WP_Customize_Section {
     21
     22        /**
     23         * The Customize Manager.
     24         *
     25         * @since 3.4.0
     26         * @access public
     27         * @var WP_Customize_Manager $manager The Customize Manager this section relates to
     28         */
    1029        public $manager;
     30
     31        /**
     32         * The specific ID of the section.
     33         *
     34         * @since 3.4.0
     35         * @access public
     36         * @var string $id The specific ID of the section.
     37         */
    1138        public $id;
     39
     40        /**
     41         * The priority of this secion relative to others.
     42         *
     43         * @since 3.4.0
     44         * @access public
     45         * @var int $priority The priority of this secion relative to others.
     46         *                    Lower numbers are displayed first.
     47         */
    1248        public $priority       = 10;
     49
     50        /**
     51         * The capability required to access this section.
     52         *
     53         * @since 3.4.0
     54         * @access public
     55         * @var int $capability The capability required to access this section.
     56         */
    1357        public $capability     = 'edit_theme_options';
     58
     59        /**
     60         * A theme feature that this section relates to.
     61         *
     62         * @since 3.4.0
     63         * @access public
     64         * @var string $theme_supports A theme feature that this section relates to
     65         */
    1466        public $theme_supports = '';
     67
     68        /**
     69         * The title of this section.
     70         *
     71         * @since 3.4.0
     72         * @access public
     73         * @var string $title The title of this section.
     74         */
    1575        public $title          = '';
     76
     77        /**
     78         * The description of this section.
     79         *
     80         * @since 3.4.0
     81         * @access public
     82         * @var string $description The description of this section.
     83         */
    1684        public $description    = '';
     85
     86        /**
     87         * An array of controls in this section.
     88         *
     89         * @since 3.4.0
     90         * @access public
     91         * @var array $controls An array of controls in this section.
     92         */
    1793        public $controls;
    1894
    1995        /**
     
    66142                if ( ! $this->check_capabilities() )
    67143                        return;
    68144
     145                /**
     146                 * Called before rendering customizer sections.
     147                 *
     148                 * @since 3.4.0
     149                 * @param WP_Customize_Section $var The WP_Customize_Section object.
     150                 */
    69151                do_action( 'customize_render_section', $this );
     152                /**
     153                 * Called before rendering customizer sections.
     154                 *
     155                 * @since 3.4.0
     156                 * @param string $var The ID of the section about to be rendered.
     157                 */
    70158                do_action( 'customize_render_section_' . $this->id );
    71159
    72160                $this->render();