WordPress.org

Make WordPress Core

Ticket #39671: 39671.2.patch

File 39671.2.patch, 10.1 KB (added by sagarprajapati, 3 years ago)
  • wp-includes/class-wp-customize-control.php

     
    7777        public $capability;
    7878
    7979        /**
     80         * Order priority to load the control.
     81         *
    8082         * @access public
    8183         * @var int
    8284         */
    8385        public $priority = 10;
    8486
    8587        /**
     88         * Section the control belongs to.
     89         *
    8690         * @access public
    8791         * @var string
    8892         */
    8993        public $section = '';
    9094
    9195        /**
     96         * Label for the control.
     97         *
    9298         * @access public
    9399         * @var string
    94100         */
    95101        public $label = '';
    96102
    97103        /**
     104         * Description for the control.
     105         *
    98106         * @access public
    99107         * @var string
    100108         */
     
    102110
    103111        /**
    104112         * @todo: Remove choices
     113         * List of choices for 'radio' or 'select' type controls, where values are the keys, and labels are the values.
    105114         *
    106115         * @access public
    107116         * @var array
     
    109118        public $choices = array();
    110119
    111120        /**
     121         * List of custom input attributes for control output, where attribute names are the keys and values are the values.
     122         *
     123         * Not used for 'checkbox', 'radio', 'select', 'textarea', or 'dropdown-pages' control types.
     124         *
    112125         * @access public
    113126         * @var array
    114127         */
  • wp-includes/class-wp-customize-manager.php

     
    27932793         * @access public
    27942794         *
    27952795         * @param WP_Customize_Setting|string $id   Customize Setting object, or ID.
    2796          * @param array                       $args Setting arguments; passed to WP_Customize_Setting
    2797          *                                          constructor.
     2796         * @param array                       $args {
     2797         *     Optional. Array of properties for the new WP_Customize_Setting. Default empty array.
     2798         *
     2799         *     @type string       $type                  Type of the setting. Default 'theme_mod'.
     2800         *                                               Default 160.
     2801         *     @type string       $capability            Capability required for the setting. Default 'edit_theme_options'
     2802         *     @type string|array $theme_supports        Theme features required to support the panel. Default is none.
     2803         *     @type string       $default               Default value for the setting. Default is empty string.
     2804         *     @type string       $transport             Options for rendering the live preview of changes in Theme Customizer.
     2805         *                                               Using 'refresh' makes the change visible by reloading the whole preview.
     2806         *                                               Using 'postMessage' allows a custom JavaScript to handle live changes.
     2807         *                                               @link https://developer.wordpress.org/themes/customize-api
     2808         *                                               Default is 'refresh'
     2809         *     @type callable     $validate_callback     Server-side validation callback for the setting's value.
     2810         *     @type callable     $sanitize_callback     Callback to filter a Customize setting value in un-slashed form.
     2811         *     @type callable     $sanitize_js_callback  Callback to convert a Customize PHP setting value to a value that is
     2812         *                                               JSON serializable.
     2813         *     @type bool         $dirty                 Whether or not the setting is initially dirty when created.
     2814         * }
    27982815         * @return WP_Customize_Setting             The instance of the setting that was added.
    27992816         */
    28002817        public function add_setting( $id, $args = array() ) {
     
    29112928         * @access public
    29122929         *
    29132930         * @param WP_Customize_Panel|string $id   Customize Panel object, or Panel ID.
    2914          * @param array                     $args Optional. Panel arguments. Default empty array.
     2931         * @param array                     $args {
     2932     *     Optional. Array of properties for the new Panel object. Default empty array.
     2933     *
     2934     *     @type int          $priority              Priority of the panel, defining the display order of panels and sections.
     2935     *                                               Default 160.
     2936     *     @type string       $capability            Capability required for the panel. Default `edit_theme_options`
     2937     *     @type string|array $theme_supports        Theme features required to support the panel.
     2938     *     @type string       $title                 Title of the panel to show in UI.
     2939     *     @type string       $description           Description to show in the UI.
     2940     *     @type string       $type                  Type of the panel.
     2941     *     @type callable     $active_callback       Active callback.
     2942     * }
    29152943         *
    29162944         * @return WP_Customize_Panel             The instance of the panel that was added.
    29172945         */
     
    30003028         * @access public
    30013029         *
    30023030         * @param WP_Customize_Section|string $id   Customize Section object, or Section ID.
    3003          * @param array                       $args Section arguments.
     3031         * @param array                     $args {
     3032     *     Optional. Array of properties for the new Panel object. Default empty array.
     3033     *
     3034     *     @type int          $priority              Priority of the panel, defining the display order of panels and sections.
     3035     *                                               Default 160.
     3036     *     @type string       $panel                 Priority of the panel, defining the display order of panels and sections.
     3037     *     @type string       $capability            Capability required for the panel. Default 'edit_theme_options'
     3038     *     @type string|array $theme_supports        Theme features required to support the panel.
     3039     *     @type string       $title                 Title of the panel to show in UI.
     3040     *     @type string       $description           Description to show in the UI.
     3041     *     @type string       $type                  Type of the panel.
     3042     *     @type callable     $active_callback       Active callback.
     3043     *     @type bool         $description_hidden    Hide the description behind a help icon, instead of . Default false.
     3044     * }
    30043045         *
    30053046         * @return WP_Customize_Section             The instance of the section that was added.
    30063047         */
     
    30763117         * @access public
    30773118         *
    30783119         * @param WP_Customize_Control|string $id   Customize Control object, or ID.
    3079          * @param array                       $args Control arguments; passed to WP_Customize_Control
    3080          *                                          constructor.
     3120         * @param array                       $args {
     3121     *     Optional. Array of properties for the new Control object. Default empty array.
     3122     *
     3123     *     @type array        $settings              All settings tied to the control. If undefined, defaults to `$setting`.
     3124     *                                               IDs in the array correspond to the ID of a registered `WP_Customize_Setting`.
     3125     *     @type string       $setting               The primary setting for the control (if there is one). Default is 'default'.
     3126     *     @type string       $capability            Capability required to use this control. Normally derived from `$settings`.
     3127     *     @type int          $priority              Order priority to load the control. Default 10.
     3128     *     @type string       $section               The section this control belongs to. Default empty.
     3129     *     @type string       $label                 Label for the control. Default empty.
     3130     *     @type string       $description           Description for the control. Default empty.
     3131     *     @type array        $choices               List of choices for 'radio' or 'select' type controls, where values
     3132     *                                               are the keys, and labels are the values. Default empty array.
     3133     *     @type array        $input_attrs           List of custom input attributes for control output, where attribute
     3134     *                                               names are the keys and values are the values. Default empty array.
     3135     *     @type bool         $allow_addition        Show UI for adding new content, currently only used for the
     3136     *                                               dropdown-pages control. Default false.
     3137     *     @type string       $type                  The type of the control. Default 'text'.
     3138     *     @type callback     $active_callback       Active callback.
     3139     * }
    30813140         * @return WP_Customize_Control             The instance of the control that was added.
    30823141         */
    30833142        public function add_control( $id, $args = array() ) {
  • wp-includes/class-wp-customize-setting.php

     
    4040        /**
    4141         * Capability required to edit this setting.
    4242         *
    43          * @var string
     43         * @var string|array
    4444         */
    4545        public $capability = 'edit_theme_options';
    4646
     
    5151         * @var string
    5252         */
    5353        public $theme_supports  = '';
     54       
     55        /**
     56     * The default value for the setting.
     57     *
     58     * @access public
     59     * @var string
     60     */
    5461        public $default         = '';
     62       
     63        /**
     64     * Options for rendering the live preview of changes in Theme Customizer.
     65     *
     66     * Set this value to 'postMessage' to enable a custom Javascript handler to render changes to this setting
     67     * as opposed to reloading the whole page.
     68     *
     69     * @link https://developer.wordpress.org/themes/customize-api
     70     *
     71     * @access public
     72     * @var string
     73     */
    5574        public $transport       = 'refresh';
    5675
    5776        /**
    58          * Server-side sanitization callback for the setting's value.
     77         * Server-side validation callback for the setting's value.
    5978         *
    60          * @var callback
     79         * @var callable
    6180         */
    6281        public $validate_callback    = '';
     82       
     83        /**
     84     * Callback to filter a Customize setting value in un-slashed form.
     85     *
     86     * @var callable
     87     */
    6388        public $sanitize_callback    = '';
     89       
     90        /**
     91     * Callback to convert a Customize PHP setting value to a value that is JSON serializable.
     92     *
     93     * @var callable
     94     */
    6495        public $sanitize_js_callback = '';
    6596
    6697        /**