WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
07/27/2017 12:40:27 AM (9 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-manager.php

    r41012 r41162  
    2626     *
    2727     * @since 3.4.0
    28      * @access protected
    2928     * @var WP_Theme
    3029     */
    … …  
    3534     *
    3635     * @since 3.4.0
    37      * @access protected
    3836     * @var string
    3937     */
    … …  
    4442     *
    4543     * @since 3.4.0
    46      * @access protected
    4744     * @var bool
    4845     */
    … …  
    5350     *
    5451     * @since 3.9.0
    55      * @access public
    5652     * @var WP_Customize_Widgets
    5753     */
    … …  
    6258     *
    6359     * @since 4.3.0
    64      * @access public
    6560     * @var WP_Customize_Nav_Menus
    6661     */
    … …  
    7166     *
    7267     * @since 4.5.0
    73      * @access public
    7468     * @var WP_Customize_Selective_Refresh
    7569     */
    … …  
    8074     *
    8175     * @since 3.4.0
    82      * @access protected
    8376     * @var array
    8477     */
    … …  
    8982     *
    9083     * @since 4.0.0
    91      * @access protected
    9284     * @var array
    9385     */
    … …  
    9890     *
    9991     * @since 4.0.0
    100      * @access protected
    10192     * @var array
    10293     */
    … …  
    10798     *
    10899     * @since 4.5.0
    109      * @access protected
    110100     * @var array
    111101     */
    … …  
    116106     *
    117107     * @since 3.4.0
    118      * @access protected
    119108     * @var array
    120109     */
    … …  
    125114     *
    126115     * @since 3.4.0
    127      * @access protected
    128116     * @var array
    129117     */
    … …  
    134122     *
    135123     * @since 4.3.0
    136      * @access protected
    137124     * @var array
    138125     */
    … …  
    143130     *
    144131     * @since 4.3.0
    145      * @access protected
    146132     * @var array
    147133     */
    … …  
    152138     *
    153139     * @since 4.1.0
    154      * @access protected
    155140     * @var array
    156141     */
    … …  
    161146     *
    162147     * @since 4.4.0
    163      * @access protected
    164148     * @var string
    165149     */
    … …  
    170154     *
    171155     * @since 4.4.0
    172      * @access protected
    173156     * @var string
    174157     */
    … …  
    179162     *
    180163     * @since 4.4.0
    181      * @access protected
    182164     * @var array
    183165     */
    … …  
    188170     *
    189171     * @since 4.7.0
    190      * @access protected
    191172     * @var string
    192173     */
    … …  
    204185     *
    205186     * @since 4.7.0
    206      * @access private
    207187     * @var string
    208188     */
    … …  
    213193     *
    214194     * @since 4.7.0
    215      * @access private
    216195     * @var int|false
    217196     */
    … …  
    222201     *
    223202     * @since 4.7.0
    224      * @access private
    225203     * @var array
    226204     */
    … …  
    374352     * @since 3.4.0
    375353     * @since 4.2.0 Added `$action` param.
    376      * @access public
    377354     *
    378355     * @param string|null $action Whether the supplied Ajax action is being run.
    … …  
    649626     *
    650627     * @since 4.7.0
    651      * @access public
    652628     *
    653629     * @return string UUID.
    … …  
    719695     *
    720696     * @since 4.0.0
    721      * @access public
    722697     *
    723698     * @return array Panels.
    … …  
    799774     *
    800775     * @since 4.7.0
    801      * @access public
    802776     *
    803777     * @param string $uuid Changeset UUID.
    … …  
    836810     *
    837811     * @since 4.7.0
    838      * @access public
    839812     *
    840813     * @return int|null Post ID on success or null if there is no post yet saved.
    … …  
    858831     *
    859832     * @since 4.7.0
    860      * @access protected
    861833     *
    862834     * @param int $post_id Changeset post ID.
    … …  
    888860     *
    889861     * @since 4.7.0
    890      * @access public
    891862     *
    892863     * @return array Changeset data.
    … …  
    914885     *
    915886     * @since 4.7.0
    916      * @access private
    917887     * @var array
    918888     */
    … …  
    923893     *
    924894     * @since 4.7.0
    925      * @access public
    926895     *
    927896     * @param array $starter_content Starter content. Defaults to `get_theme_starter_content()`.
    … …  
    13161285     *
    13171286     * @since 4.7.0
    1318      * @access private
    13191287     *
    13201288     * @param array $attachments Attachments.
    … …  
    13771345     *
    13781346     * @since 4.7.0
    1379      * @access private
    13801347     */
    13811348    public function _save_starter_content_changeset() {
    … …  
    14861453     * @since 4.1.1 Introduced the `$default` parameter.
    14871454     * @since 4.6.0 `$default` is now returned early when the setting post value is invalid.
    1488      * @access public
    14891455     *
    14901456     * @see WP_REST_Server::dispatch()
    … …  
    15211487     *
    15221488     * @since 4.2.0
    1523      * @access public
    15241489     *
    15251490     * @param string $setting_id ID for the WP_Customize_Setting instance.
    … …  
    16191584     *
    16201585     * @since 4.7.0
    1621      * @access public
    16221586     *
    16231587     * @param array $headers Headers.
    … …  
    16351599     *
    16361600     * @since 4.7.0
    1637      * @access public
    16381601     * @see wp_redirect()
    16391602     * @see WP_Customize_Manager::get_allowed_url()
    … …  
    16811644     * @since 4.0.0
    16821645     * @deprecated 4.7.0
    1683      * @access public
    16841646     */
    16851647    public function customize_preview_override_404_status() {
    … …  
    17111673     *
    17121674     * @since 4.2.0
    1713      * @access public
    17141675     */
    17151676    public function customize_preview_loading_style() {
    … …  
    17421703     *
    17431704     * @since 4.7.0
    1744      * @access public
    17451705     */
    17461706    public function remove_frameless_preview_messenger_channel() {
    … …  
    19921952     *
    19931953     * @since 4.6.0
    1994      * @access public
    19951954     *
    19961955     * @see WP_REST_Request::has_valid_params()
    … …  
    20592018     *
    20602019     * @since 4.6.0
    2061      * @access public
    20622020     *
    20632021     * @param true|WP_Error $validity Setting validity.
    … …  
    22262184     *
    22272185     * @since 4.7.0
    2228      * @access public
    22292186     *
    22302187     * @param array $args {
    … …  
    25702527     *
    25712528     * @since 4.7.0
    2572      * @access private
    25732529     * @var bool
    25742530     */
    … …  
    25812537     *
    25822538     * @since 4.7.0
    2583      * @access private
    25842539     *
    25852540     * @param bool    $post_has_changed Whether the post has changed.
    … …  
    26112566     *
    26122567     * @since 4.7.0
    2613      * @access private
    26142568     * @see _wp_customize_publish_changeset()
    26152569     *
    … …  
    27622716     *
    27632717     * @since 4.7.0
    2764      * @access private
    27652718     *
    27662719     * @param array $inactive_theme_mod_settings Mapping of stylesheet to arrays of theme mod settings.
    … …  
    28662819     *
    28672820     * @since 4.2.0
    2868      * @access public
    28692821     *
    28702822     * @param array $setting_ids The setting IDs to add.
    … …  
    29782930     *
    29792931     * @since 4.0.0
    2980      * @access public
    29812932     *
    29822933     * @param string $id Panel ID to get.
    … …  
    29932944     *
    29942945     * @since 4.0.0
    2995      * @access public
    29962946     *
    29972947     * @param string $id Panel ID to remove.
    … …  
    30172967     *
    30182968     * @since 4.3.0
    3019      * @access public
    30202969     *
    30212970     * @see WP_Customize_Panel
    … …  
    30312980     *
    30322981     * @since 4.3.0
    3033      * @access public
    30342982     */
    30352983    public function render_panel_templates() {
    … …  
    30452993     * @since 3.4.0
    30462994     * @since 4.5.0 Return added WP_Customize_Section instance.
    3047      * @access public
    30482995     *
    30492996     * @param WP_Customize_Section|string $id   Customize Section object, or Section ID.
    … …  
    31043051     *
    31053052     * @since 4.3.0
    3106      * @access public
    31073053     *
    31083054     * @see WP_Customize_Section
    … …  
    31183064     *
    31193065     * @since 4.3.0
    3120      * @access public
    31213066     */
    31223067    public function render_section_templates() {
    … …  
    31323077     * @since 3.4.0
    31333078     * @since 4.5.0 Return added WP_Customize_Control instance.
    3134      * @access public
    31353079     *
    31363080     * @param WP_Customize_Control|string $id   Customize Control object, or ID.
    … …  
    31983142     *
    31993143     * @since 4.1.0
    3200      * @access public
    32013144     *
    32023145     * @param string $control Name of a custom control which is a subclass of
    … …  
    32113154     *
    32123155     * @since 4.1.0
    3213      * @access public
    32143156     */
    32153157    public function render_control_templates() {
    … …  
    33513293     *
    33523294     * @since 4.4.0
    3353      * @access public
    33543295     *
    33553296     * @return bool Whether the user agent is iOS.
    … …  
    33633304     *
    33643305     * @since 4.4.0
    3365      * @access public
    33663306     *
    33673307     * @return string The template string for the document title.
    … …  
    33853325     *
    33863326     * @since 4.4.0
    3387      * @access public
    33883327     *
    33893328     * @param string $preview_url URL to be previewed.
    … …  
    33983337     *
    33993338     * @since 4.4.0
    3400      * @access public
    34013339     *
    34023340     * @return string URL being previewed.
    … …  
    34153353     *
    34163354     * @since 4.7.0
    3417      * @access public
    34183355     *
    34193356     * @return bool Whether cross-domain.
    … …  
    34373374     *
    34383375     * @since 4.7.0
    3439      * @access public
    34403376     *
    34413377     * @returns array Allowed URLs.
    … …  
    34643400     *
    34653401     * @since 4.7.0
    3466      * @access public
    34673402     *
    34683403     * @return string Messenger channel.
    … …  
    34783413     *
    34793414     * @since 4.4.0
    3480      * @access public
    34813415     *
    34823416     * @param string $return_url URL for return link.
    … …  
    34933427     *
    34943428     * @since 4.4.0
    3495      * @access public
    34963429     *
    34973430     * @return string URL for link to close Customizer.
    … …  
    35173450     *
    35183451     * @since 4.4.0
    3519      * @access public
    35203452     *
    35213453     * @param array $autofocus {
    … …  
    35353467     *
    35363468     * @since 4.4.0
    3537      * @access public
    35383469     *
    35393470     * @return array {
    … …  
    42664197     *
    42674198     * @since 4.2.0
    4268      * @access public
    42694199     *
    42704200     * @see add_dynamic_settings()
Note: See TracChangeset for help on using the changeset viewer.