WordPress.org

Make WordPress Core

Ticket #39671: 39671.8.diff

File 39671.8.diff, 29.0 KB (added by westonruter, 2 years ago)

Fix a couple incorrect @since tags; revert changes to kses.php; improve a couple descriptions

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

    diff --git src/wp-includes/class-wp-customize-control.php src/wp-includes/class-wp-customize-control.php
    index 07c6dcfce1..3d00803131 100644
    class WP_Customize_Control { 
    3737        public $instance_number;
    3838
    3939        /**
     40         * Customizer manager.
     41         *
     42         * @since 3.4.0
    4043         * @access public
    4144         * @var WP_Customize_Manager
    4245         */
    4346        public $manager;
    4447
    4548        /**
     49         * Control ID.
     50         *
     51         * @since 3.4.0
    4652         * @access public
    4753         * @var string
    4854         */
    class WP_Customize_Control { 
    5157        /**
    5258         * All settings tied to the control.
    5359         *
     60         * @since 3.4.0
    5461         * @access public
    5562         * @var array
    5663         */
    class WP_Customize_Control { 
    5966        /**
    6067         * The primary setting for the control (if there is one).
    6168         *
     69         * @since 3.4.0
    6270         * @access public
    6371         * @var string
    6472         */
    class WP_Customize_Control { 
    7785        public $capability;
    7886
    7987        /**
     88         * Order priority to load the control in Customizer.
     89         *
     90         * @since 3.4.0
    8091         * @access public
    8192         * @var int
    8293         */
    8394        public $priority = 10;
    8495
    8596        /**
     97         * Section the control belongs to.
     98         *
     99         * @since 3.4.0
    86100         * @access public
    87101         * @var string
    88102         */
    89103        public $section = '';
    90104
    91105        /**
     106         * Label for the control.
     107         *
     108         * @since 3.4.0
    92109         * @access public
    93110         * @var string
    94111         */
    95112        public $label = '';
    96113
    97114        /**
     115         * Description for the control.
     116         *
     117         * @since 3.4.0
    98118         * @access public
    99119         * @var string
    100120         */
    101121        public $description = '';
    102122
    103123        /**
    104          * @todo: Remove choices
     124         * List of choices for 'radio' or 'select' type controls, where values are the keys, and labels are the values.
    105125         *
     126         * @since 3.4.0
    106127         * @access public
    107128         * @var array
    108129         */
    109130        public $choices = array();
    110131
    111132        /**
     133         * List of custom input attributes for control output, where attribute names are the keys and values are the values.
     134         *
     135         * Not used for 'checkbox', 'radio', 'select', 'textarea', or 'dropdown-pages' control types.
     136         *
     137         * @since 4.0.0
    112138         * @access public
    113139         * @var array
    114140         */
    class WP_Customize_Control { 
    131157        public $json = array();
    132158
    133159        /**
     160         * Control's Type.
     161         *
     162         * @since 3.4.0
    134163         * @access public
    135164         * @var string
    136165         */
  • src/wp-includes/class-wp-customize-manager.php

    diff --git src/wp-includes/class-wp-customize-manager.php src/wp-includes/class-wp-customize-manager.php
    index 097be0cf5e..df26d6e02a 100644
    final class WP_Customize_Manager { 
    642642         * Get the theme being customized.
    643643         *
    644644         * @since 3.4.0
     645         * @access public
    645646         *
    646647         * @return WP_Theme
    647648         */
    final class WP_Customize_Manager { 
    656657         * Get the registered settings.
    657658         *
    658659         * @since 3.4.0
     660         * @access public
    659661         *
    660662         * @return array
    661663         */
    final class WP_Customize_Manager { 
    667669         * Get the registered controls.
    668670         *
    669671         * @since 3.4.0
     672         * @access public
    670673         *
    671674         * @return array
    672675         */
    final class WP_Customize_Manager { 
    678681         * Get the registered containers.
    679682         *
    680683         * @since 4.0.0
     684         * @access public
    681685         *
    682686         * @return array
    683687         */
    final class WP_Customize_Manager { 
    689693         * Get the registered sections.
    690694         *
    691695         * @since 3.4.0
     696         * @access public
    692697         *
    693698         * @return array
    694699         */
    final class WP_Customize_Manager { 
    712717         * Checks if the current theme is active.
    713718         *
    714719         * @since 3.4.0
     720         * @access public
    715721         *
    716722         * @return bool
    717723         */
    final class WP_Customize_Manager { 
    723729         * Register styles/scripts and initialize the preview of each setting
    724730         *
    725731         * @since 3.4.0
     732         * @access public
    726733         */
    727734        public function wp_loaded() {
    728735
    final class WP_Customize_Manager { 
    762769         *
    763770         * @since 3.4.0
    764771         * @deprecated 4.7.0
     772         * @access public
    765773         *
    766774         * @param int $status Status.
    767775         * @return int
    final class WP_Customize_Manager { 
    15461554         * Print JavaScript settings.
    15471555         *
    15481556         * @since 3.4.0
     1557         * @access public
    15491558         */
    15501559        public function customize_preview_init() {
    15511560
    final class WP_Customize_Manager { 
    16831692         *
    16841693         * @since 3.4.0
    16851694         * @deprecated 4.7.0 Customizer no longer supports IE8, so all supported browsers recognize HTML5.
     1695         * @access public
    16861696         */
    16871697        public function customize_preview_html5() {
    16881698                _deprecated_function( __FUNCTION__, '4.7.0' );
    final class WP_Customize_Manager { 
    17581768         * Print JavaScript settings for preview frame.
    17591769         *
    17601770         * @since 3.4.0
     1771         * @access public
    17611772         */
    17621773        public function customize_preview_settings() {
    17631774                $post_values = $this->unsanitized_post_values( array( 'exclude_changeset' => true ) );
    final class WP_Customize_Manager { 
    18771888         *
    18781889         * @since 3.4.0
    18791890         * @deprecated 4.7.0
     1891         * @access public
    18801892         */
    18811893        public function customize_preview_signature() {
    18821894                _deprecated_function( __METHOD__, '4.7.0' );
    final class WP_Customize_Manager { 
    18871899         *
    18881900         * @since 3.4.0
    18891901         * @deprecated 4.7.0
     1902         * @access public
    18901903         *
    18911904         * @param mixed $return Value passed through for {@see 'wp_die_handler'} filter.
    18921905         * @return mixed Value passed through for {@see 'wp_die_handler'} filter.
    final class WP_Customize_Manager { 
    19011914         * Is it a theme preview?
    19021915         *
    19031916         * @since 3.4.0
     1917         * @access public
    19041918         *
    19051919         * @return bool True if it's a preview, false if not.
    19061920         */
    final class WP_Customize_Manager { 
    19121926         * Retrieve the template name of the previewed theme.
    19131927         *
    19141928         * @since 3.4.0
     1929         * @access public
    19151930         *
    19161931         * @return string Template name.
    19171932         */
    final class WP_Customize_Manager { 
    19231938         * Retrieve the stylesheet name of the previewed theme.
    19241939         *
    19251940         * @since 3.4.0
     1941         * @access public
    19261942         *
    19271943         * @return string Stylesheet name.
    19281944         */
    final class WP_Customize_Manager { 
    19341950         * Retrieve the template root of the previewed theme.
    19351951         *
    19361952         * @since 3.4.0
     1953         * @access public
    19371954         *
    19381955         * @return string Theme root.
    19391956         */
    final class WP_Customize_Manager { 
    19451962         * Retrieve the stylesheet root of the previewed theme.
    19461963         *
    19471964         * @since 3.4.0
     1965         * @access public
    19481966         *
    19491967         * @return string Theme root.
    19501968         */
    final class WP_Customize_Manager { 
    19561974         * Filters the current theme and return the name of the previewed theme.
    19571975         *
    19581976         * @since 3.4.0
     1977         * @access public
    19591978         *
    19601979         * @param $current_theme {@internal Parameter is not used}
    19611980         * @return string Theme name.
    final class WP_Customize_Manager { 
    20672086         *
    20682087         * @since 3.4.0
    20692088         * @since 4.7.0 The semantics of this method have changed to update a changeset, optionally to also change the status and other attributes.
     2089         * @access public
    20702090         */
    20712091        public function save() {
    20722092                if ( ! is_user_logged_in() ) {
    final class WP_Customize_Manager { 
    27782798         * Refresh nonces for the current preview.
    27792799         *
    27802800         * @since 4.2.0
     2801         * @access public
    27812802         */
    27822803        public function refresh_nonces() {
    27832804                if ( ! $this->is_preview() ) {
    final class WP_Customize_Manager { 
    27952816         * @access public
    27962817         *
    27972818         * @param WP_Customize_Setting|string $id   Customize Setting object, or ID.
    2798          * @param array                       $args Setting arguments; passed to WP_Customize_Setting
    2799          *                                          constructor.
     2819         * @param array                       $args {
     2820         *  Optional. Array of properties for the new WP_Customize_Setting. Default empty array.
     2821         *
     2822         *  @type string       $type                  Type of the setting. Default 'theme_mod'.
     2823         *                                            Default 160.
     2824         *  @type string       $capability            Capability required for the setting. Default 'edit_theme_options'
     2825         *  @type string|array $theme_supports        Theme features required to support the panel. Default is none.
     2826         *  @type string       $default               Default value for the setting. Default is empty string.
     2827         *  @type string       $transport             Options for rendering the live preview of changes in Theme Customizer.
     2828         *                                            Using 'refresh' makes the change visible by reloading the whole preview.
     2829         *                                            Using 'postMessage' allows a custom JavaScript to handle live changes.
     2830         *                                            @link https://developer.wordpress.org/themes/customize-api
     2831         *                                            Default is 'refresh'
     2832         *  @type callable     $validate_callback     Server-side validation callback for the setting's value.
     2833         *  @type callable     $sanitize_callback     Callback to filter a Customize setting value in un-slashed form.
     2834         *  @type callable     $sanitize_js_callback  Callback to convert a Customize PHP setting value to a value that is
     2835         *                                            JSON serializable.
     2836         *  @type bool         $dirty                 Whether or not the setting is initially dirty when created.
     2837         * }
    28002838         * @return WP_Customize_Setting             The instance of the setting that was added.
    28012839         */
    28022840        public function add_setting( $id, $args = array() ) {
    final class WP_Customize_Manager { 
    28842922         * Retrieve a customize setting.
    28852923         *
    28862924         * @since 3.4.0
     2925         * @access public
    28872926         *
    28882927         * @param string $id Customize Setting ID.
    28892928         * @return WP_Customize_Setting|void The setting, if set.
    final class WP_Customize_Manager { 
    28982937         * Remove a customize setting.
    28992938         *
    29002939         * @since 3.4.0
     2940         * @access public
    29012941         *
    29022942         * @param string $id Customize Setting ID.
    29032943         */
    final class WP_Customize_Manager { 
    29132953         * @access public
    29142954         *
    29152955         * @param WP_Customize_Panel|string $id   Customize Panel object, or Panel ID.
    2916          * @param array                     $args Optional. Panel arguments. Default empty array.
    2917          *
     2956         * @param array                     $args {
     2957         *  Optional. Array of properties for the new Panel object. Default empty array.
     2958         *  @type int          $priority              Priority of the panel, defining the display order of panels and sections.
     2959         *                                            Default 160.
     2960         *  @type string       $capability            Capability required for the panel. Default `edit_theme_options`
     2961         *  @type string|array $theme_supports        Theme features required to support the panel.
     2962         *  @type string       $title                 Title of the panel to show in UI.
     2963         *  @type string       $description           Description to show in the UI.
     2964         *  @type string       $type                  Type of the panel.
     2965         *  @type callable     $active_callback       Active callback.
     2966         * }
    29182967         * @return WP_Customize_Panel             The instance of the panel that was added.
    29192968         */
    29202969        public function add_panel( $id, $args = array() ) {
    final class WP_Customize_Manager { 
    30023051         * @access public
    30033052         *
    30043053         * @param WP_Customize_Section|string $id   Customize Section object, or Section ID.
    3005          * @param array                       $args Section arguments.
    3006          *
     3054         * @param array                     $args {
     3055         *  Optional. Array of properties for the new Panel object. Default empty array.
     3056         *  @type int          $priority              Priority of the panel, defining the display order of panels and sections.
     3057         *                                            Default 160.
     3058         *  @type string       $panel                 Priority of the panel, defining the display order of panels and sections.
     3059         *  @type string       $capability            Capability required for the panel. Default 'edit_theme_options'
     3060         *  @type string|array $theme_supports        Theme features required to support the panel.
     3061         *  @type string       $title                 Title of the panel to show in UI.
     3062         *  @type string       $description           Description to show in the UI.
     3063         *  @type string       $type                  Type of the panel.
     3064         *  @type callable     $active_callback       Active callback.
     3065         *  @type bool         $description_hidden    Hide the description behind a help icon, instead of . Default false.
     3066         * }
    30073067         * @return WP_Customize_Section             The instance of the section that was added.
    30083068         */
    30093069        public function add_section( $id, $args = array() ) {
    final class WP_Customize_Manager { 
    30213081         * Retrieve a customize section.
    30223082         *
    30233083         * @since 3.4.0
     3084         * @access public
    30243085         *
    30253086         * @param string $id Section ID.
    30263087         * @return WP_Customize_Section|void The section, if set.
    final class WP_Customize_Manager { 
    30343095         * Remove a customize section.
    30353096         *
    30363097         * @since 3.4.0
     3098         * @access public
    30373099         *
    30383100         * @param string $id Section ID.
    30393101         */
    final class WP_Customize_Manager { 
    30783140         * @access public
    30793141         *
    30803142         * @param WP_Customize_Control|string $id   Customize Control object, or ID.
    3081          * @param array                       $args Control arguments; passed to WP_Customize_Control
    3082          *                                          constructor.
     3143         * @param array                       $args {
     3144         *  Optional. Array of properties for the new Control object. Default empty array.
     3145         *
     3146         *  @type array        $settings              All settings tied to the control. If undefined, defaults to `$setting`.
     3147         *                                            IDs in the array correspond to the ID of a registered `WP_Customize_Setting`.
     3148         *  @type string       $setting               The primary setting for the control (if there is one). Default is 'default'.
     3149         *  @type string       $capability            Capability required to use this control. Normally derived from `$settings`.
     3150         *  @type int          $priority              Order priority to load the control. Default 10.
     3151         *  @type string       $section               The section this control belongs to. Default empty.
     3152         *  @type string       $label                 Label for the control. Default empty.
     3153         *  @type string       $description           Description for the control. Default empty.
     3154         *  @type array        $choices               List of choices for 'radio' or 'select' type controls, where values
     3155         *                                            are the keys, and labels are the values. Default empty array.
     3156         *  @type array        $input_attrs           List of custom input attributes for control output, where attribute
     3157         *                                            names are the keys and values are the values. Default empty array.
     3158         *  @type bool         $allow_addition        Show UI for adding new content, currently only used for the
     3159         *                                            dropdown-pages control. Default false.
     3160         *  @type string       $type                  The type of the control. Default 'text'.
     3161         *  @type callback     $active_callback       Active callback.
     3162         * }
    30833163         * @return WP_Customize_Control             The instance of the control that was added.
    30843164         */
    30853165        public function add_control( $id, $args = array() ) {
    final class WP_Customize_Manager { 
    30973177         * Retrieve a customize control.
    30983178         *
    30993179         * @since 3.4.0
     3180         * @access public
    31003181         *
    31013182         * @param string $id ID of the control.
    31023183         * @return WP_Customize_Control|void The control object, if set.
    final class WP_Customize_Manager { 
    31103191         * Remove a customize control.
    31113192         *
    31123193         * @since 3.4.0
     3194         * @access public
    31133195         *
    31143196         * @param string $id ID of the control.
    31153197         */
    final class WP_Customize_Manager { 
    31613243         *
    31623244         * @since 3.4.0
    31633245         * @deprecated 4.7.0 Use wp_list_sort()
     3246         * @access protected
    31643247         *
    31653248         * @param WP_Customize_Panel|WP_Customize_Section|WP_Customize_Control $a Object A.
    31663249         * @param WP_Customize_Panel|WP_Customize_Section|WP_Customize_Control $b Object B.
    final class WP_Customize_Manager { 
    31843267         * and sort by priority.
    31853268         *
    31863269         * @since 3.4.0
     3270         * @access public
    31873271         */
    31883272        public function prepare_controls() {
    31893273
    final class WP_Customize_Manager { 
    32653349         * Enqueue scripts for customize controls.
    32663350         *
    32673351         * @since 3.4.0
     3352         * @access public
    32683353         */
    32693354        public function enqueue_control_scripts() {
    32703355                foreach ( $this->controls as $control ) {
    final class WP_Customize_Manager { 
    34783563         * Get nonces for the Customizer.
    34793564         *
    34803565         * @since 4.5.0
     3566         * @access public
     3567         *
    34813568         * @return array Nonces.
    34823569         */
    34833570        public function get_nonces() {
    final class WP_Customize_Manager { 
    35043591         * Print JavaScript settings for parent window.
    35053592         *
    35063593         * @since 4.4.0
     3594         * @access public
    35073595         */
    35083596        public function customize_pane_settings() {
    35093597
    final class WP_Customize_Manager { 
    36183706        /**
    36193707         * Returns a list of devices to allow previewing.
    36203708         *
    3621          * @access public
    36223709         * @since 4.5.0
     3710         * @access public
    36233711         *
    36243712         * @return array List of devices with labels and default setting.
    36253713         */
    final class WP_Customize_Manager { 
    36553743         * Register some default controls.
    36563744         *
    36573745         * @since 3.4.0
     3746         * @access public
    36583747         */
    36593748        public function register_controls() {
    36603749
    final class WP_Customize_Manager { 
    41704259         *
    41714260         * Used as active callback for static front page section and controls.
    41724261         *
    4173          * @access private
    41744262         * @since 4.7.0
     4263         * @access public
    41754264         *
    41764265         * @returns bool Whether there are published (or to be published) pages.
    41774266         */
    final class WP_Customize_Manager { 
    42084297         * Returns default text color if hex color is empty.
    42094298         *
    42104299         * @since 3.4.0
     4300         * @access public
    42114301         *
    42124302         * @param string $color
    42134303         * @return mixed
    final class WP_Customize_Manager { 
    42274317         * Callback for validating a background setting value.
    42284318         *
    42294319         * @since 4.7.0
    4230          * @access private
     4320         * @access public
    42314321         *
    42324322         * @param string $value Repeat value.
    42334323         * @param WP_Customize_Setting $setting Setting.
    final class WP_Customize_Manager { 
    42704360         * Export header video settings to facilitate selective refresh.
    42714361         *
    42724362         * @since 4.7.0
     4363         * @access public
    42734364         *
    42744365         * @param array $response Response.
    42754366         * @param WP_Customize_Selective_Refresh $selective_refresh Selective refresh component.
    final class WP_Customize_Manager { 
    42904381         * Ensures that the selected video is less than 8MB and provides an error message.
    42914382         *
    42924383         * @since 4.7.0
     4384         * @access public
    42934385         *
    42944386         * @param WP_Error $validity
    42954387         * @param mixed $value
    final class WP_Customize_Manager { 
    43224414         * Ensures that the provided URL is supported.
    43234415         *
    43244416         * @since 4.7.0
     4417         * @access public
    43254418         *
    43264419         * @param WP_Error $validity
    43274420         * @param mixed $value
    final class WP_Customize_Manager { 
    43414434         * Callback for sanitizing the external_header_video value.
    43424435         *
    43434436         * @since 4.7.1
     4437         * @access public
    43444438         *
    43454439         * @param string $value URL.
    43464440         * @return string Sanitized URL.
    final class WP_Customize_Manager { 
    43614455         * @see WP_Customize_Manager::register_controls()
    43624456         *
    43634457         * @since 4.5.0
    4364          * @access private
     4458         * @access public
    43654459         *
    43664460         * @return string Custom logo.
    43674461         */
  • src/wp-includes/class-wp-customize-setting.php

    diff --git src/wp-includes/class-wp-customize-setting.php src/wp-includes/class-wp-customize-setting.php
    index 83a5b76d61..2e062db111 100644
     
    1818 */
    1919class WP_Customize_Setting {
    2020        /**
     21         * Customizer bootstrap instance.
     22         *
     23         * @since 3.4.0
    2124         * @access public
    2225         * @var WP_Customize_Manager
    2326         */
    class WP_Customize_Setting { 
    2629        /**
    2730         * Unique string identifier for the setting.
    2831         *
     32         * @since 3.4.0
    2933         * @access public
    3034         * @var string
    3135         */
    3236        public $id;
    3337
    3438        /**
     39         * Type of customize settings.
     40         *
     41         * @since 3.4.0
    3542         * @access public
    3643         * @var string
    3744         */
    class WP_Customize_Setting { 
    4047        /**
    4148         * Capability required to edit this setting.
    4249         *
    43          * @var string
     50         * @since 3.4.0
     51         * @access public
     52         * @var string|array
    4453         */
    4554        public $capability = 'edit_theme_options';
    4655
    4756        /**
    4857         * Feature a theme is required to support to enable this setting.
    4958         *
     59         * @since 3.4.0
     60         * @access public
     61         * @var string
     62         */
     63        public $theme_supports = '';
     64
     65        /**
     66         * The default value for the setting.
     67         *
     68         * @since 3.4.0
     69         * @access public
     70         * @var string
     71         */
     72        public $default = '';
     73
     74        /**
     75         * Options for rendering the live preview of changes in Theme Customizer.
     76         *
     77         * Set this value to 'postMessage' to enable a custom Javascript handler to render changes to this setting
     78         * as opposed to reloading the whole page.
     79         *
     80         * @link https://developer.wordpress.org/themes/customize-api
     81         *
     82         * @since 3.4.0
    5083         * @access public
    5184         * @var string
    5285         */
    53         public $theme_supports  = '';
    54         public $default         = '';
    55         public $transport       = 'refresh';
     86        public $transport = 'refresh';
     87
     88        /**
     89         * Server-side validation callback for the setting's value.
     90         *
     91         * @since 4.6.0
     92         * @access public
     93         * @var callable
     94         */
     95        public $validate_callback = '';
     96
     97        /**
     98         * Callback to filter a Customize setting value in un-slashed form.
     99         *
     100         * @since 3.4.0
     101         * @access public
     102         * @var callable
     103         */
     104        public $sanitize_callback = '';
    56105
    57106        /**
    58          * Server-side sanitization callback for the setting's value.
     107         * Callback to convert a Customize PHP setting value to a value that is JSON serializable.
    59108         *
    60          * @var callback
     109         * @since 3.4.0
     110         * @access public
     111         * @var string
    61112         */
    62         public $validate_callback    = '';
    63         public $sanitize_callback    = '';
    64113        public $sanitize_js_callback = '';
    65114
    66115        /**
    class WP_Customize_Setting { 
    78127        public $dirty = false;
    79128
    80129        /**
     130         * @access protected
    81131         * @var array
    82132         */
    83133        protected $id_data = array();
    class WP_Customize_Setting { 
    95145         * Cache of multidimensional values to improve performance.
    96146         *
    97147         * @since 4.4.0
     148         * @static
    98149         * @access protected
    99150         * @var array
    100          * @static
    101151         */
    102152        protected static $aggregated_multidimensionals = array();
    103153
    class WP_Customize_Setting { 
    116166         * Any supplied $args override class property defaults.
    117167         *
    118168         * @since 3.4.0
     169         * @access public
    119170         *
    120171         * @param WP_Customize_Manager $manager
    121172         * @param string               $id      An specific ID of the setting. Can be a
    class WP_Customize_Setting { 
    252303         *
    253304         * @see WP_Customize_Setting::preview()
    254305         * @since 4.1.1
     306         * @access protected
    255307         * @var mixed
    256308         */
    257309        protected $_original_value;
    class WP_Customize_Setting { 
    379431         * is called for this setting.
    380432         *
    381433         * @since 4.4.0
    382          * @access private
     434         * @access public
     435         *
    383436         * @see WP_Customize_Manager::set_post_value()
    384437         * @see WP_Customize_Setting::_multidimensional_preview_filter()
    385438         */
    class WP_Customize_Setting { 
    395448         * the original value.
    396449         *
    397450         * @since 3.4.0
     451         * @access public
    398452         *
    399453         * @param mixed $original Old value.
    400454         * @return mixed New or old value.
    class WP_Customize_Setting { 
    426480         * the first setting previewed will be used to apply the values for the others.
    427481         *
    428482         * @since 4.4.0
    429          * @access private
     483         * @access public
    430484         *
    431485         * @see WP_Customize_Setting::$aggregated_multidimensionals
    432486         * @param mixed $original Original root value.
    class WP_Customize_Setting { 
    468522         * the value of the setting.
    469523         *
    470524         * @since 3.4.0
    471          *
    472525         * @access public
    473526         *
    474527         * @return false|void False if cap check fails or value isn't set or is invalid.
    class WP_Customize_Setting { 
    503556         * During a save request prior to save, post_value() provides the new value while value() does not.
    504557         *
    505558         * @since 3.4.0
     559         * @access public
    506560         *
    507561         * @param mixed $default A default value which is used as a fallback. Default is null.
    508562         * @return mixed The default value on failure, otherwise the sanitized and validated value.
    class WP_Customize_Setting { 
    515569         * Sanitize an input.
    516570         *
    517571         * @since 3.4.0
     572         * @access public
    518573         *
    519574         * @param string|array $value    The value to sanitize.
    520575         * @return string|array|null|WP_Error Sanitized value, or `null`/`WP_Error` if invalid.
    class WP_Customize_Setting { 
    633688         * Save the value of the setting, using the related API.
    634689         *
    635690         * @since 3.4.0
     691         * @access protected
    636692         *
    637693         * @param mixed $value The value to update.
    638694         * @return bool The result of saving the value.
    class WP_Customize_Setting { 
    671727         *
    672728         * @since 3.4.0
    673729         * @deprecated 4.4.0 Deprecated in favor of update() method.
     730         * @access protected
    674731         */
    675732        protected function _update_theme_mod() {
    676733                _deprecated_function( __METHOD__, '4.4.0', __CLASS__ . '::update()' );
    class WP_Customize_Setting { 
    681738         *
    682739         * @since 3.4.0
    683740         * @deprecated 4.4.0 Deprecated in favor of update() method.
     741         * @access protected
    684742         */
    685743        protected function _update_option() {
    686744                _deprecated_function( __METHOD__, '4.4.0', __CLASS__ . '::update()' );
    class WP_Customize_Setting { 
    690748         * Fetch the value of the setting.
    691749         *
    692750         * @since 3.4.0
     751         * @access public
    693752         *
    694753         * @return mixed The value.
    695754         */
    class WP_Customize_Setting { 
    743802         * Sanitize the setting's value for use in JavaScript.
    744803         *
    745804         * @since 3.4.0
     805         * @access public
    746806         *
    747807         * @return mixed The requested escaped value.
    748808         */
    class WP_Customize_Setting { 
    787847         * Validate user capabilities whether the theme supports the setting.
    788848         *
    789849         * @since 3.4.0
     850         * @access public
    790851         *
    791852         * @return bool False if theme doesn't support the setting or user can't change setting, otherwise true.
    792853         */
    class WP_Customize_Setting { 
    804865         * Multidimensional helper function.
    805866         *
    806867         * @since 3.4.0
     868         * @access protected
    807869         *
    808870         * @param $root
    809871         * @param $keys
    class WP_Customize_Setting { 
    854916         * Will attempt to replace a specific value in a multidimensional array.
    855917         *
    856918         * @since 3.4.0
     919         * @access protected
    857920         *
    858921         * @param $root
    859922         * @param $keys
    class WP_Customize_Setting { 
    878941         * Will attempt to fetch a specific value from a multidimensional array.
    879942         *
    880943         * @since 3.4.0
     944         * @access protected
    881945         *
    882946         * @param $root
    883947         * @param $keys
    class WP_Customize_Setting { 
    896960         * Will attempt to check if a specific value in a multidimensional array is set.
    897961         *
    898962         * @since 3.4.0
     963         * @access protected
    899964         *
    900965         * @param $root
    901966         * @param $keys
    class WP_Customize_Setting { 
    907972        }
    908973}
    909974
    910 /** WP_Customize_Filter_Setting class */
     975/**
     976 * WP_Customize_Filter_Setting class.
     977 */
    911978require_once( ABSPATH . WPINC . '/customize/class-wp-customize-filter-setting.php' );
    912979
    913 /** WP_Customize_Header_Image_Setting class */
     980/**
     981 * WP_Customize_Header_Image_Setting class.
     982 */
    914983require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-setting.php' );
    915984
    916 /** WP_Customize_Background_Image_Setting class */
     985/**
     986 * WP_Customize_Background_Image_Setting class.
     987 */
    917988require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-setting.php' );
    918989
    919 /** WP_Customize_Nav_Menu_Item_Setting class */
     990/**
     991 * WP_Customize_Nav_Menu_Item_Setting class.
     992 */
    920993require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-setting.php' );
    921994
    922 /** WP_Customize_Nav_Menu_Setting class */
     995/**
     996 * WP_Customize_Nav_Menu_Setting class.
     997 */
    923998require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-setting.php' );
  • src/wp-includes/customize/class-wp-customize-selective-refresh.php

    diff --git src/wp-includes/customize/class-wp-customize-selective-refresh.php src/wp-includes/customize/class-wp-customize-selective-refresh.php
    index 6c04a73698..db0c04fa7b 100644
    final class WP_Customize_Selective_Refresh { 
    9191         * @access public
    9292         *
    9393         * @param WP_Customize_Partial|string $id   Customize Partial object, or Panel ID.
    94          * @param array                       $args Optional. Partial arguments. Default empty array.
     94         * @param array                       $args {
     95         *  Optional. Array of properties for the new Partials object. Default empty array.
     96         *
     97         *  @type string   $type                  Type of the partial to be created.
     98         *  @type string   $selector              The jQuery selector to find the container element for the partial.
     99         *  @type array    $settings              IDs for settings tied to the partial.
     100         *  @type string   $primary_setting       The ID for the setting that this partial is primarily responsible for
     101         *                                        rendering. If not supplied, it will default to the ID of the first setting.
     102         *  @type string   $capability            Capability required to edit this partial.
     103         *                                        Normally this is empty and the capability is derived from the capabilities
     104         *                                        of the associated `$settings`.
     105         *  @type callable $render_callback       Render callback.
     106         *                                        Callback is called with one argument, the instance of WP_Customize_Partial.
     107         *                                        The callback can either echo the partial or return the partial as a string,
     108         *                                        or return false if error.
     109         *  @type bool     $container_inclusive   Whether the container element is included in the partial, or if only
     110         *                                        the contents are rendered.
     111         *  @type bool     $fallback_refresh      Whether to refresh the entire preview in case a partial cannot be refreshed.
     112         *                                        A partial render is considered a failure if the render_callback returns
     113         *                                        false.
     114         * }
    95115         * @return WP_Customize_Partial             The instance of the panel that was added.
    96116         */
    97117        public function add_partial( $id, $args = array() ) {