WordPress.org

Make WordPress Core

Ticket #39671: 39671.3.patch

File 39671.3.patch, 9.9 KB (added by ketuchetan, 4 years ago)

  • src/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
     84         * @since 4.8.0
    8285         */
    8386        public $priority = 10;
    8487
    8588        /**
     89         * Section the control belongs to.
     90         *
    8691         * @access public
    8792         * @var string
     93         * @since 4.8.0
    8894         */
    8995        public $section = '';
    9096
    9197        /**
     98         * Label for the control.
     99         *
    92100         * @access public
    93101         * @var string
     102         * @since 4.8.0
    94103         */
    95104        public $label = '';
    96105
    97106        /**
     107         * Description for the control.
     108         *
    98109         * @access public
    99110         * @var string
     111         * @since 4.8.0
    100112         */
    101113        public $description = '';
    102114
    103115        /**
    104          * @todo: Remove choices
     116         * List of choices for 'radio' or 'select' type controls, where values are the keys, and labels are the values.
    105117         *
    106118         * @access public
    107119         * @var array
     120         * @since 4.8.0
    108121         */
    109122        public $choices = array();
    110123
    111124        /**
     125         * List of custom input attributes for control output, where attribute names are the keys and values are the values.
     126         *
     127         * Not used for 'checkbox', 'radio', 'select', 'textarea', or 'dropdown-pages' control types.
     128         *
    112129         * @access public
    113130         * @var array
     131         * @since 4.8.0
    114132         */
    115133        public $input_attrs = array();
    116134

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

     
    27952795         * @access public
    27962796         *
    27972797         * @param WP_Customize_Setting|string $id   Customize Setting object, or ID.
    2798          * @param array                       $args Setting arguments; passed to WP_Customize_Setting
    2799          *                                          constructor.
     2798         * @param array                       $args {
     2799         *  Optional. Array of properties for the new WP_Customize_Setting. Default empty array.
     2800         *
     2801         *  @type string       $type                  Type of the setting. Default 'theme_mod'.
     2802         *                                            Default 160.
     2803         *  @type string       $capability            Capability required for the setting. Default 'edit_theme_options'
     2804         *  @type string|array $theme_supports        Theme features required to support the panel. Default is none.
     2805         *  @type string       $default               Default value for the setting. Default is empty string.
     2806         *  @type string       $transport             Options for rendering the live preview of changes in Theme Customizer.
     2807         *                                            Using 'refresh' makes the change visible by reloading the whole preview.
     2808         *                                            Using 'postMessage' allows a custom JavaScript to handle live changes.
     2809         *                                            @link https://developer.wordpress.org/themes/customize-api
     2810         *                                            Default is 'refresh'
     2811         *  @type callable     $validate_callback     Server-side validation callback for the setting's value.
     2812         *  @type callable     $sanitize_callback     Callback to filter a Customize setting value in un-slashed form.
     2813         *  @type callable     $sanitize_js_callback  Callback to convert a Customize PHP setting value to a value that is JSON serializable.
     2814         *  @type bool         $dirty                 Whether or not the setting is initially dirty when created.
     2815         * }
    28002816         * @return WP_Customize_Setting             The instance of the setting that was added.
    28012817         */
    28022818        public function add_setting( $id, $args = array() ) {
    … …  
    29132929         * @access public
    29142930         *
    29152931         * @param WP_Customize_Panel|string $id   Customize Panel object, or Panel ID.
    2916          * @param array                     $args Optional. Panel arguments. Default empty array.
     2932         * @param array                     $args {
     2933         *  Optional. Array of properties for the new Panel object. Default empty array.
    29172934         *
     2935         *  @type int          $priority              Priority of the panel, defining the display order of panels and sections.
     2936         *                                            Default 160.
     2937         *  @type string       $capability            Capability required for the panel. Default `edit_theme_options`
     2938         *  @type string|array $theme_supports        Theme features required to support the panel.
     2939         *  @type string       $title                 Title of the panel to show in UI.
     2940         *  @type string       $description           Description to show in the UI.
     2941         *  @type string       $type                  Type of the panel.
     2942         *  @type callable     $active_callback       Active callback.
     2943         *
     2944         * }
     2945         *
    29182946         * @return WP_Customize_Panel             The instance of the panel that was added.
    29192947         */
    29202948        public function add_panel( $id, $args = array() ) {
    … …  
    30023030         * @access public
    30033031         *
    30043032         * @param WP_Customize_Section|string $id   Customize Section object, or Section ID.
    3005          * @param array                       $args Section arguments.
     3033         * @param array                     $args {
     3034         *  Optional. Array of properties for the new Panel object. Default empty array.
    30063035         *
     3036         *  @type int          $priority              Priority of the panel, defining the display order of panels and sections.
     3037         *                                            Default 160.
     3038         *  @type string       $panel                 Priority of the panel, defining the display order of panels and sections.
     3039         *  @type string       $capability            Capability required for the panel. Default 'edit_theme_options'
     3040         *  @type string|array $theme_supports        Theme features required to support the panel.
     3041         *  @type string       $title                 Title of the panel to show in UI.
     3042         *  @type string       $description           Description to show in the UI.
     3043         *  @type string       $type                  Type of the panel.
     3044         *  @type callable     $active_callback       Active callback.
     3045         *  @type bool         $description_hidden    Hide the description behind a help icon, instead of . Default false.
     3046         * }
     3047         *
    30073048         * @return WP_Customize_Section             The instance of the section that was added.
    30083049         */
    30093050        public function add_section( $id, $args = array() ) {
    … …  
    30783119         * @access public
    30793120         *
    30803121         * @param WP_Customize_Control|string $id   Customize Control object, or ID.
    3081          * @param array                       $args Control arguments; passed to WP_Customize_Control
    3082          *                                          constructor.
     3122         * @param array                       $args {
     3123         *  Optional. Array of properties for the new Control object. Default empty array.
     3124         *
     3125         *  @type array        $settings              All settings tied to the control. If undefined, defaults to `$setting`.
     3126         *                                            IDs in the array correspond to the ID of a registered `WP_Customize_Setting`.
     3127         *  @type string       $setting               The primary setting for the control (if there is one). Default is 'default'.
     3128         *  @type string       $capability            Capability required to use this control. Normally derived from `$settings`.
     3129         *  @type int          $priority              Order priority to load the control. Default 10.
     3130         *  @type string       $section               The section this control belongs to. Default empty.
     3131         *  @type string       $label                 Label for the control. Default empty.
     3132         *  @type string       $description           Description for the control. Default empty.
     3133         *  @type array        $choices               List of choices for 'radio' or 'select' type controls, where values
     3134         *                                            are the keys, and labels are the values. Default empty array.
     3135         *  @type array        $input_attrs           List of custom input attributes for control output, where attribute
     3136         *                                            names are the keys and values are the values. Default empty array.
     3137         *  @type bool         $allow_addition        Show UI for adding new content, currently only used for the
     3138         *                                            dropdown-pages control. Default false.
     3139         *  @type string       $type                  The type of the control. Default 'text'.
     3140         *  @type callback     $active_callback       Active callback.
     3141         * }
     3142         *
    30833143         * @return WP_Customize_Control             The instance of the control that was added.
    30843144         */
    30853145        public function add_control( $id, $args = array() ) {

  • src/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 string
     94         */
    6495        public $sanitize_js_callback = '';
    6596
    6697        /**