Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:40:27 AM (7 years ago)
Author:
DrewAPicture
Message:

Docs: Remove @access notations from method DocBlocks in wp-includes/* classes.

Prior to about 2013, many class methods lacked even access modifiers which made the @access notations that much more useful. Now that we've gotten to a point where the codebase is more mature from a maintenance perspective and we can finally remove these notations. Notable exceptions to this change include standalone functions notated as private as well as some classes still considered to represent "private" APIs.

See #41452.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-customize-widgets.php

    r41002 r41162  
    2323     *
    2424     * @since 3.9.0
    25      * @access public
    2625     * @var WP_Customize_Manager
    2726     */
     
    3231     *
    3332     * @since 3.9.0
    34      * @access protected
    3533     * @var array
    3634     */
     
    5755    /**
    5856     * @since 3.9.0
    59      * @access protected
    6057     * @var array
    6158     */
     
    6461    /**
    6562     * @since 3.9.0
    66      * @access protected
    6763     * @var array
    6864     */
     
    7167    /**
    7268     * @since 3.9.0
    73      * @access protected
    7469     * @var array
    7570     */
     
    8075     *
    8176     * @since 4.5.0
    82      * @access protected
    8377     * @var array
    8478     */
     
    8983     *
    9084     * @since 4.2.0
    91      * @access protected
    9285     * @var array
    9386     */
     
    10194     *
    10295     * @since 3.9.0
    103      * @access public
    10496     *
    10597     * @param WP_Customize_Manager $manager Customize manager bootstrap instance.
     
    144136     *
    145137     * @since 4.5.0
    146      * @access public
    147138     *
    148139     * @global WP_Widget_Factory $wp_widget_factory
     
    169160     *
    170161     * @since 4.5.0
    171      * @access public
    172162     *
    173163     * @param string $id_base Widget ID Base.
     
    183173     *
    184174     * @since 4.2.0
    185      * @access protected
    186175     *
    187176     * @staticvar array $cache
     
    208197     *
    209198     * @since 4.2.0
    210      * @access public
    211199     */
    212200    public function register_settings() {
     
    240228     *
    241229     * @since 4.2.0
    242      * @access public
    243230     *
    244231     * @param false|array $args       The arguments to the WP_Customize_Setting constructor.
     
    257244     *
    258245     * @since 3.9.0
    259      * @access protected
    260246     *
    261247     * @param string $name    Post value.
     
    281267     *
    282268     * @since 3.9.0
    283      * @access public
    284269     *
    285270     * @global array $sidebars_widgets
     
    314299     *
    315300     * @since 3.9.0
    316      * @access public
    317301     *
    318302     * @see WP_Customize_Widgets::handle_theme_switch()
     
    333317     *
    334318     * @since 3.9.0
    335      * @access public
    336319     *
    337320     * @see WP_Customize_Widgets::handle_theme_switch()
     
    353336     *
    354337     * @since 3.9.0
    355      * @access public
    356338     */
    357339    public function customize_controls_init() {
     
    373355     *
    374356     * @since 3.9.0
    375      * @access public
    376357     */
    377358    public function schedule_customize_register() {
     
    387368     *
    388369     * @since 3.9.0
    389      * @access public
    390370     *
    391371     * @global array $wp_registered_widgets
     
    538518     *
    539519     * @since 4.4.0
    540      * @access public
    541520     *
    542521     * @see WP_Customize_Panel::$active_callback
     
    554533     *
    555534     * @since 3.9.0
    556      * @access public
    557535     *
    558536     * @param string $widget_id Widget ID.
     
    580558     *
    581559     * @since 3.9.0
    582      * @access public
    583560     *
    584561     * @global $wp_registered_widget_controls
     
    610587     *
    611588     * @since 3.9.0
    612      * @access public
    613589     *
    614590     * @param string $widget_id Widget ID.
     
    635611     *
    636612     * @since 3.9.0
    637      * @access public
    638613     *
    639614     * @param string $setting_id Widget setting ID.
     
    657632     *
    658633     * @since 3.9.0
    659      * @access public
    660634     */
    661635    public function print_styles() {
     
    672646     *
    673647     * @since 3.9.0
    674      * @access public
    675648     */
    676649    public function print_scripts() {
     
    686659     *
    687660     * @since 3.9.0
    688      * @access public
    689661     *
    690662     * @global WP_Scripts $wp_scripts
     
    823795     *
    824796     * @since 3.9.0
    825      * @access public
    826797     */
    827798    public function output_widget_control_templates() {
     
    866837     *
    867838     * @since 3.9.0
    868      * @access public
    869839     */
    870840    public function print_footer_scripts() {
     
    883853     *
    884854     * @since 3.9.0
    885      * @access public
    886855     *
    887856     * @param string $id        Widget setting ID.
     
    927896     *
    928897     * @since 3.9.0
    929      * @access public
    930898     *
    931899     * @param array $widget_ids Array of widget IDs.
     
    945913     *
    946914     * @since 3.9.0
    947      * @access public
    948915     *
    949916     * @global array $wp_registered_widgets
     
    1032999     *
    10331000     * @since 3.9.0
    1034      * @access protected
    10351001     *
    10361002     * @param array $widget_a The first widget to compare.
     
    10461012     *
    10471013     * @since 3.9.0
    1048      * @access public
    10491014     *
    10501015     * @param array $args Widget control arguments.
     
    10661031     *
    10671032     * @since 4.4.0
    1068      * @access public
    10691033     *
    10701034     * @param array $args Widget control arguments.
     
    10971061     *
    10981062     * @since 3.9.0
    1099      * @access public
    11001063     */
    11011064    public function customize_preview_init() {
     
    11091072     *
    11101073     * @since 4.2.0
    1111      * @access public
    11121074     *
    11131075     * @param  array $nonces Array of nonces.
     
    11281090     *
    11291091     * @since 3.9.0
    1130      * @access public
    11311092     *
    11321093     * @param array $sidebars_widgets List of widgets for the current sidebar.
     
    11441105     *
    11451106     * @since 3.9.0
    1146      * @access public
    11471107     */
    11481108    public function customize_preview_enqueue() {
     
    11551115     *
    11561116     * @since 3.9.0
    1157      * @access public
    11581117     */
    11591118    public function print_preview_css() {
     
    12161175     *
    12171176     * @since 3.9.0
    1218      * @access public
    12191177     *
    12201178     * @param array $widget Rendered widget to tally.
     
    12281186     *
    12291187     * @since 4.0.0
    1230      * @access public
    12311188     *
    12321189     * @param string $widget_id Widget ID to check.
     
    12411198     *
    12421199     * @since 4.0.0
    1243      * @access public
    12441200     *
    12451201     * @param string $sidebar_id Sidebar ID to check.
     
    12581214     *
    12591215     * @since 3.9.0
    1260      * @access public
    12611216     *
    12621217     * @param bool   $is_active  Whether the sidebar is active.
     
    12841239     *
    12851240     * @since 3.9.0
    1286      * @access public
    12871241     *
    12881242     * @param bool   $has_widgets Whether the current sidebar has widgets.
     
    13101264     *
    13111265     * @since 3.9.0
    1312      * @access protected
    13131266     *
    13141267     * @param string $serialized_instance Widget instance.
     
    13261279     *
    13271280     * @since 3.9.0
    1328      * @access public
    13291281     *
    13301282     * @param array $value Widget instance to sanitize.
     
    13641316     *
    13651317     * @since 3.9.0
    1366      * @access public
    13671318     *
    13681319     * @param array $value Widget instance to convert to JSON.
     
    13901341     *
    13911342     * @since 3.9.0
    1392      * @access public
    13931343     *
    13941344     * @global array $wp_registered_widgets
     
    14091359     *
    14101360     * @since 3.9.0
    1411      * @access public
    14121361     *
    14131362     * @global array $wp_registered_widget_updates
     
    15391488     *
    15401489     * @since 3.9.0
    1541      * @access public
    15421490     *
    15431491     * @see wp_ajax_save_widget()
     
    16021550     *
    16031551     * @since 4.5.0
    1604      * @access public
    16051552     *
    16061553     * @param array|false $partial_args Partial arguments.
     
    16361583     *
    16371584     * @since 4.5.0
    1638      * @access public
    16391585     */
    16401586    public function selective_refresh_init() {
     
    17121658     *
    17131659     * @since 4.5.0
    1714      * @access protected
    17151660     * @var array
    17161661     */
     
    17231668     *
    17241669     * @since 4.5.0
    1725      * @access public
    17261670     *
    17271671     * @param array $allowed_html Allowed HTML.
     
    17531697     *
    17541698     * @since 4.5.0
    1755      * @access protected
    17561699     * @var array
    17571700     */
     
    17621705     *
    17631706     * @since 4.5.0
    1764      * @access protected
    17651707     * @var int
    17661708     */
     
    17711713     *
    17721714     * @since 4.5.0
    1773      * @access protected
    17741715     * @var array
    17751716     */
     
    17821723     *
    17831724     * @since 4.5.0
    1784      * @access public
    17851725     *
    17861726     * @param int|string $index Index, name, or ID of the dynamic sidebar.
     
    18031743     *
    18041744     * @since 4.5.0
    1805      * @access public
    18061745     *
    18071746     * @param int|string $index Index, name, or ID of the dynamic sidebar.
     
    18181757     *
    18191758     * @since 4.5.0
    1820      * @access protected
    18211759     * @var string
    18221760     */
     
    18271765     *
    18281766     * @since 4.5.0
    1829      * @access protected
    18301767     * @var string
    18311768     */
     
    18361773     *
    18371774     * @since 4.5.0
    1838      * @access protected
    18391775     *
    18401776     * @param array $sidebars_widgets Sidebars widgets.
     
    18501786     *
    18511787     * @since 4.5.0
    1852      * @access public
    18531788     *
    18541789     * @see dynamic_sidebar()
     
    19091844     *
    19101845     * @since 3.9.0
    1911      * @access protected
    19121846     * @var array $_captured_options Values updated while option capture is happening.
    19131847     */
     
    19181852     *
    19191853     * @since 3.9.0
    1920      * @access protected
    19211854     * @var bool $_is_current Whether option capture is currently happening or not.
    19221855     */
     
    19271860     *
    19281861     * @since 3.9.0
    1929      * @access protected
    19301862     *
    19311863     * @param string $option_name Option name.
     
    19401872     *
    19411873     * @since 3.9.0
    1942      * @access protected
    19431874     *
    19441875     * @return array Array of captured options.
     
    19521883     *
    19531884     * @since 4.2.0
    1954      * @access protected
    19551885     *
    19561886     * @param string $option_name Option name.
     
    19711901     *
    19721902     * @since 3.9.0
    1973      * @access protected
    19741903     *
    19751904     * @return int Number of updated options.
     
    19831912     *
    19841913     * @since 3.9.0
    1985      * @access protected
    19861914     */
    19871915    protected function start_capturing_option_updates() {
     
    19991927     *
    20001928     * @since 3.9.0
    2001      * @access public
    20021929     *
    20031930     * @param mixed  $new_value   The new option value.
     
    20241951     *
    20251952     * @since 3.9.0
    2026      * @access public
    20271953     *
    20281954     * @param mixed $value Value to return instead of the option value.
     
    20461972     *
    20471973     * @since 3.9.0
    2048      * @access protected
    20491974     */
    20501975    protected function stop_capturing_option_updates() {
Note: See TracChangeset for help on using the changeset viewer.