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-nav-menus.php

    r41004 r41162  
    2323     *
    2424     * @since 4.3.0
    25      * @access public
    2625     * @var WP_Customize_Manager
    2726     */
     
    3231     *
    3332     * @since 4.3.0
    34      * @access public
    3533     * @var array
    3634     */
     
    4139     *
    4240     * @since 4.3.0
    43      * @access public
    4441     *
    4542     * @param object $manager An instance of the WP_Customize_Manager class.
     
    7875     *
    7976     * @since 4.5.0
    80      * @access public
    8177     *
    8278     * @param array $nonces Array of nonces.
     
    9288     *
    9389     * @since 4.3.0
    94      * @access public
    9590     */
    9691    public function ajax_load_available_items() {
     
    136131     *
    137132     * @since 4.3.0
    138      * @access public
    139133     *
    140134     * @param string $type   Optional. Accepts any custom object type and has built-in support for
     
    259253     *
    260254     * @since 4.3.0
    261      * @access public
    262255     */
    263256    public function ajax_search_available_items() {
     
    293286     *
    294287     * @since 4.3.0
    295      * @access public
    296288     *
    297289     * @param array $args Optional. Accepts 'pagenum' and 's' (search) arguments.
     
    396388     *
    397389     * @since 4.3.0
    398      * @access public
    399390     */
    400391    public function enqueue_scripts() {
     
    481472     *
    482473     * @since 4.3.0
    483      * @access public
    484474     *
    485475     * @param false|array $setting_args The arguments to the WP_Customize_Setting constructor.
     
    506496     *
    507497     * @since 4.3.0
    508      * @access public
    509498     *
    510499     * @param string $setting_class WP_Customize_Setting or a subclass.
     
    528517     *
    529518     * @since 4.3.0
    530      * @access public
    531519     */
    532520    public function customize_register() {
     
    709697     *
    710698     * @since 4.3.0
    711      * @access public
    712699     *
    713700     * @param mixed $value Number to convert.
     
    723710     * @since 4.3.0
    724711     * @since 4.7.0  Each array item now includes a `$type_label` in in addition to `$title`, `$type`, and `$object`.
    725      * @access public
    726712     *
    727713     * @return array The available menu item types.
     
    773759     * Add a new `auto-draft` post.
    774760     *
    775      * @access public
    776761     * @since 4.7.0
    777762     *
     
    823808     * Ajax handler for adding a new auto-draft post.
    824809     *
    825      * @access public
    826810     * @since 4.7.0
    827811     */
     
    900884     *
    901885     * @since 4.3.0
    902      * @access public
    903886     */
    904887    public function print_templates() {
     
    943926     *
    944927     * @since 4.3.0
    945      * @access public
    946928     */
    947929    public function available_items_template() {
     
    1004986     *
    1005987     * @since 4.7.0
    1006      * @access private
    1007988     *
    1008989     * @param array $available_item_type Menu item data to output, including title, type, and label.
     
    10441025     *
    10451026     * @since 4.7.0
    1046      * @access private
    10471027     *
    10481028     * @return void
     
    10871067     *
    10881068     * @since 4.3.0
    1089      * @access public
    10901069     * @var array
    10911070     */
     
    10961075     *
    10971076     * @since 4.5.0
    1098      * @access public
    10991077     *
    11001078     * @param array|false $partial_args Partial args.
     
    11271105     *
    11281106     * @since 4.3.0
    1129      * @access public
    11301107     */
    11311108    public function customize_preview_init() {
     
    11411118     *
    11421119     * @since 4.7.0
    1143      * @access public
    11441120     *
    11451121     * @global array $wp_post_statuses List of post statuses.
     
    11541130     *
    11551131     * @since 4.7.0
    1156      * @access public
    11571132     *
    11581133     * @param array $value Post IDs.
     
    11901165     *
    11911166     * @since 4.7.0
    1192      * @access public
    11931167     *
    11941168     * @param WP_Customize_Setting $setting Customizer setting object.
     
    12201194     *
    12211195     * @since 4.3.0
    1222      * @access public
    12231196     * @see wp_nav_menu()
    12241197     * @see WP_Customize_Widgets_Partial_Refresh::filter_dynamic_sidebar_params()
     
    12881261     *
    12891262     * @since 4.3.0
    1290      * @access public
    12911263     *
    12921264     * @see wp_nav_menu()
     
    13131285     *
    13141286     * @since 4.3.0
    1315      * @access public
    13161287     *
    13171288     * @param array $args The arguments to hash.
     
    13261297     *
    13271298     * @since 4.3.0
    1328      * @access public
    13291299     */
    13301300    public function customize_preview_enqueue_deps() {
     
    13361306     *
    13371307     * @since 4.3.0
    1338      * @access public
    13391308     */
    13401309    public function export_preview_data() {
     
    13511320     *
    13521321     * @since 4.5.0
    1353      * @access public
    13541322     *
    13551323     * @param array $response Response.
     
    13651333     *
    13661334     * @since 4.3.0
    1367      * @access public
    13681335     *
    13691336     * @see wp_nav_menu()
Note: See TracChangeset for help on using the changeset viewer.