WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
05/19/2017 08:24:58 PM (9 years ago)
Author:
westonruter
Message:

Docs: Improve phpdoc for WP_Customize_Manager, WP_Customize_Control, WP_Customize_Setting, and WP_Customize_Selective_Refresh.

Props 4nickpick, sagarprajapati, ketuchetan, BharatKambariya, mrahmadawais, westonruter.
Fixes #39671.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r39345 r40804  
    3838
    3939    /**
     40     * Customizer manager.
     41     *
     42     * @since 3.4.0
    4043     * @access public
    4144     * @var WP_Customize_Manager
    … …  
    4447
    4548    /**
     49     * Control ID.
     50     *
     51     * @since 3.4.0
    4652     * @access public
    4753     * @var string
    … …  
    5258     * All settings tied to the control.
    5359     *
     60     * @since 3.4.0
    5461     * @access public
    5562     * @var array
    … …  
    6067     * The primary setting for the control (if there is one).
    6168     *
     69     * @since 3.4.0
    6270     * @access public
    6371     * @var string
    … …  
    7886
    7987    /**
     88     * Order priority to load the control in Customizer.
     89     *
     90     * @since 3.4.0
    8091     * @access public
    8192     * @var int
    … …  
    8495
    8596    /**
     97     * Section the control belongs to.
     98     *
     99     * @since 3.4.0
    86100     * @access public
    87101     * @var string
    … …  
    90104
    91105    /**
     106     * Label for the control.
     107     *
     108     * @since 3.4.0
    92109     * @access public
    93110     * @var string
    … …  
    96113
    97114    /**
     115     * Description for the control.
     116     *
     117     * @since 4.0.0
    98118     * @access public
    99119     * @var string
    … …  
    102122
    103123    /**
    104      * @todo: Remove choices
    105      *
     124     * List of choices for 'radio' or 'select' type controls, where values are the keys, and labels are the values.
     125     *
     126     * @since 3.4.0
    106127     * @access public
    107128     * @var 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
    … …  
    126152    /**
    127153     * @deprecated It is better to just call the json() method
     154     * @since 3.4.0
    128155     * @access public
    129156     * @var array
    … …  
    132159
    133160    /**
     161     * Control's Type.
     162     *
     163     * @since 3.4.0
    134164     * @access public
    135165     * @var string
    … …  
    236266     *
    237267     * @since 4.0.0
    238      * @access public
    239268     *
    240269     * @return bool Whether the control is active to the current preview.
    … …  
    264293     *
    265294     * @since 4.0.0
    266      * @access public
    267295     *
    268296     * @return true Always true.
    … …  
    447475     *
    448476     * @since 4.0.0
    449      * @access public
    450477     */
    451478    public function input_attrs() {
    … …  
    649676}
    650677
    651 /** WP_Customize_Color_Control class */
     678/**
     679 * WP_Customize_Color_Control class.
     680 */
    652681require_once( ABSPATH . WPINC . '/customize/class-wp-customize-color-control.php' );
    653682
    654 /** WP_Customize_Media_Control class */
     683/**
     684 * WP_Customize_Media_Control class.
     685 */
    655686require_once( ABSPATH . WPINC . '/customize/class-wp-customize-media-control.php' );
    656687
    657 /** WP_Customize_Upload_Control class */
     688/**
     689 * WP_Customize_Upload_Control class.
     690 */
    658691require_once( ABSPATH . WPINC . '/customize/class-wp-customize-upload-control.php' );
    659692
    660 /** WP_Customize_Image_Control class */
     693/**
     694 * WP_Customize_Image_Control class.
     695 */
    661696require_once( ABSPATH . WPINC . '/customize/class-wp-customize-image-control.php' );
    662697
    663 /** WP_Customize_Background_Image_Control class */
     698/**
     699 * WP_Customize_Background_Image_Control class.
     700 */
    664701require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-image-control.php' );
    665702
    666 /** WP_Customize_Background_Position_Control class */
     703/**
     704 * WP_Customize_Background_Position_Control class.
     705 */
    667706require_once( ABSPATH . WPINC . '/customize/class-wp-customize-background-position-control.php' );
    668707
    669 /** WP_Customize_Cropped_Image_Control class */
     708/**
     709 * WP_Customize_Cropped_Image_Control class.
     710 */
    670711require_once( ABSPATH . WPINC . '/customize/class-wp-customize-cropped-image-control.php' );
    671712
    672 /** WP_Customize_Site_Icon_Control class */
     713/**
     714 * WP_Customize_Site_Icon_Control class.
     715 */
    673716require_once( ABSPATH . WPINC . '/customize/class-wp-customize-site-icon-control.php' );
    674717
    675 /** WP_Customize_Header_Image_Control class */
     718/**
     719 * WP_Customize_Header_Image_Control class.
     720 */
    676721require_once( ABSPATH . WPINC . '/customize/class-wp-customize-header-image-control.php' );
    677722
    678 /** WP_Customize_Theme_Control class */
     723/**
     724 * WP_Customize_Theme_Control class.
     725 */
    679726require_once( ABSPATH . WPINC . '/customize/class-wp-customize-theme-control.php' );
    680727
    681 /** WP_Widget_Area_Customize_Control class */
     728/**
     729 * WP_Widget_Area_Customize_Control class.
     730 */
    682731require_once( ABSPATH . WPINC . '/customize/class-wp-widget-area-customize-control.php' );
    683732
    684 /** WP_Widget_Form_Customize_Control class */
     733/**
     734 * WP_Widget_Form_Customize_Control class.
     735 */
    685736require_once( ABSPATH . WPINC . '/customize/class-wp-widget-form-customize-control.php' );
    686737
    687 /** WP_Customize_Nav_Menu_Control class */
     738/**
     739 * WP_Customize_Nav_Menu_Control class.
     740 */
    688741require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-control.php' );
    689742
    690 /** WP_Customize_Nav_Menu_Item_Control class */
     743/**
     744 * WP_Customize_Nav_Menu_Item_Control class.
     745 */
    691746require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-item-control.php' );
    692747
    693 /** WP_Customize_Nav_Menu_Location_Control class */
     748/**
     749 * WP_Customize_Nav_Menu_Location_Control class.
     750 */
    694751require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-location-control.php' );
    695752
    696 /** WP_Customize_Nav_Menu_Name_Control class */
     753/**
     754 * WP_Customize_Nav_Menu_Name_Control class.
     755 */
    697756require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-name-control.php' );
    698757
    699 /** WP_Customize_Nav_Menu_Auto_Add_Control class */
     758/**
     759 * WP_Customize_Nav_Menu_Auto_Add_Control class.
     760 */
    700761require_once( ABSPATH . WPINC . '/customize/class-wp-customize-nav-menu-auto-add-control.php' );
    701762
    702 /** WP_Customize_New_Menu_Control class */
     763/**
     764 * WP_Customize_New_Menu_Control class.
     765 */
    703766require_once( ABSPATH . WPINC . '/customize/class-wp-customize-new-menu-control.php' );
Note: See TracChangeset for help on using the changeset viewer.