IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
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.

Built from https://develop.svn.wordpress.org/trunk@41162


git-svn-id: http://core.svn.wordpress.org/trunk@41002 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
2017-07-27 00:41:44 +00:00
parent 1a28ec87e1
commit 0860bb2771
136 changed files with 3 additions and 1907 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
wp-includes/class-wp-customize-nav-menus.php
View File

@@ -22,7 +22,6 @@ final class WP_Customize_Nav_Menus {
* WP_Customize_Manager instance.
*
* @since 4.3.0
* @access public
* @var WP_Customize_Manager
*/
public $manager;
@@ -31,7 +30,6 @@ final class WP_Customize_Nav_Menus {
* Previewed Menus.
*
* @since 4.3.0
* @access public
* @var array
*/
public $previewed_menus;
@@ -40,7 +38,6 @@ final class WP_Customize_Nav_Menus {
* Constructor.
*
* @since 4.3.0
* @access public
*
* @param object $manager An instance of the WP_Customize_Manager class.
*/
@@ -77,7 +74,6 @@ final class WP_Customize_Nav_Menus {
* Adds a nonce for customizing menus.
*
* @since 4.5.0
* @access public
*
* @param array $nonces Array of nonces.
* @return array $nonces Modified array of nonces.
@@ -91,7 +87,6 @@ final class WP_Customize_Nav_Menus {
* Ajax handler for loading available menu items.
*
* @since 4.3.0
* @access public
*/
public function ajax_load_available_items() {
check_ajax_referer( 'customize-menus', 'customize-menus-nonce' );
@@ -135,7 +130,6 @@ final class WP_Customize_Nav_Menus {
* Performs the post_type and taxonomy queries for loading available menu items.
*
* @since 4.3.0
* @access public
*
* @param string $type Optional. Accepts any custom object type and has built-in support for
* 'post_type' and 'taxonomy'. Default is 'post_type'.
@@ -258,7 +252,6 @@ final class WP_Customize_Nav_Menus {
* Ajax handler for searching available menu items.
*
* @since 4.3.0
* @access public
*/
public function ajax_search_available_items() {
check_ajax_referer( 'customize-menus', 'customize-menus-nonce' );
@@ -292,7 +285,6 @@ final class WP_Customize_Nav_Menus {
* Based on WP_Editor::wp_link_query().
*
* @since 4.3.0
* @access public
*
* @param array $args Optional. Accepts 'pagenum' and 's' (search) arguments.
* @return array Menu items.
@@ -395,7 +387,6 @@ final class WP_Customize_Nav_Menus {
* Enqueue scripts and styles for Customizer pane.
*
* @since 4.3.0
* @access public
*/
public function enqueue_scripts() {
wp_enqueue_style( 'customize-nav-menus' );
@@ -480,7 +471,6 @@ final class WP_Customize_Nav_Menus {
* the WP_Customize_Setting constructor.
*
* @since 4.3.0
* @access public
*
* @param false|array $setting_args The arguments to the WP_Customize_Setting constructor.
* @param string $setting_id ID for dynamic setting, usually coming from `$_POST['customized']`.
@@ -505,7 +495,6 @@ final class WP_Customize_Nav_Menus {
* Allow non-statically created settings to be constructed with custom WP_Customize_Setting subclass.
*
* @since 4.3.0
* @access public
*
* @param string $setting_class WP_Customize_Setting or a subclass.
* @param string $setting_id ID for dynamic setting, usually coming from `$_POST['customized']`.
@@ -527,7 +516,6 @@ final class WP_Customize_Nav_Menus {
* Add the customizer settings and controls.
*
* @since 4.3.0
* @access public
*/
public function customize_register() {
@@ -708,7 +696,6 @@ final class WP_Customize_Nav_Menus {
* intval because the second argument is not what intval() expects.
*
* @since 4.3.0
* @access public
*
* @param mixed $value Number to convert.
* @return int Integer.
@@ -722,7 +709,6 @@ final class WP_Customize_Nav_Menus {
*
* @since 4.3.0
* @since 4.7.0 Each array item now includes a `$type_label` in in addition to `$title`, `$type`, and `$object`.
* @access public
*
* @return array The available menu item types.
*/
@@ -772,7 +758,6 @@ final class WP_Customize_Nav_Menus {
/**
* Add a new `auto-draft` post.
*
* @access public
* @since 4.7.0
*
* @param array $postarr {
@@ -822,7 +807,6 @@ final class WP_Customize_Nav_Menus {
/**
* Ajax handler for adding a new auto-draft post.
*
* @access public
* @since 4.7.0
*/
public function ajax_insert_auto_draft_post() {
@@ -899,7 +883,6 @@ final class WP_Customize_Nav_Menus {
* Templates are imported into the JS use wp.template.
*
* @since 4.3.0
* @access public
*/
public function print_templates() {
?>
@@ -942,7 +925,6 @@ final class WP_Customize_Nav_Menus {
* Print the html template used to render the add-menu-item frame.
*
* @since 4.3.0
* @access public
*/
public function available_items_template() {
?>
@@ -1003,7 +985,6 @@ final class WP_Customize_Nav_Menus {
* To be used in the template #available-menu-items.
*
* @since 4.7.0
* @access private
*
* @param array $available_item_type Menu item data to output, including title, type, and label.
* @return void
@@ -1043,7 +1024,6 @@ final class WP_Customize_Nav_Menus {
* Print the markup for available menu item custom links.
*
* @since 4.7.0
* @access private
*
* @return void
*/
@@ -1086,7 +1066,6 @@ final class WP_Customize_Nav_Menus {
* Nav menu args used for each instance, keyed by the args HMAC.
*
* @since 4.3.0
* @access public
* @var array
*/
public $preview_nav_menu_instance_args = array();
@@ -1095,7 +1074,6 @@ final class WP_Customize_Nav_Menus {
* Filters arguments for dynamic nav_menu selective refresh partials.
*
* @since 4.5.0
* @access public
*
* @param array|false $partial_args Partial args.
* @param string $partial_id Partial ID.
@@ -1126,7 +1104,6 @@ final class WP_Customize_Nav_Menus {
* Add hooks for the Customizer preview.
*
* @since 4.3.0
* @access public
*/
public function customize_preview_init() {
add_action( 'wp_enqueue_scripts', array( $this, 'customize_preview_enqueue_deps' ) );
@@ -1140,7 +1117,6 @@ final class WP_Customize_Nav_Menus {
* Make the auto-draft status protected so that it can be queried.
*
* @since 4.7.0
* @access public
*
* @global array $wp_post_statuses List of post statuses.
*/
@@ -1153,7 +1129,6 @@ final class WP_Customize_Nav_Menus {
* Sanitize post IDs for auto-draft posts created for nav menu items to be published.
*
* @since 4.7.0
* @access public
*
* @param array $value Post IDs.
* @returns array Post IDs.
@@ -1189,7 +1164,6 @@ final class WP_Customize_Nav_Menus {
* post is not an auto-draft.
*
* @since 4.7.0
* @access public
*
* @param WP_Customize_Setting $setting Customizer setting object.
*/
@@ -1219,7 +1193,6 @@ final class WP_Customize_Nav_Menus {
* Keep track of the arguments that are being passed to wp_nav_menu().
*
* @since 4.3.0
* @access public
* @see wp_nav_menu()
* @see WP_Customize_Widgets_Partial_Refresh::filter_dynamic_sidebar_params()
*
@@ -1287,7 +1260,6 @@ final class WP_Customize_Nav_Menus {
* Injects attributes into container element.
*
* @since 4.3.0
* @access public
*
* @see wp_nav_menu()
*
@@ -1312,7 +1284,6 @@ final class WP_Customize_Nav_Menus {
* Note that the array is expected to be pre-sorted.
*
* @since 4.3.0
* @access public
*
* @param array $args The arguments to hash.
* @return string Hashed nav menu arguments.
@@ -1325,7 +1296,6 @@ final class WP_Customize_Nav_Menus {
* Enqueue scripts for the Customizer preview.
*
* @since 4.3.0
* @access public
*/
public function customize_preview_enqueue_deps() {
wp_enqueue_script( 'customize-preview-nav-menus' ); // Note that we have overridden this.
@@ -1335,7 +1305,6 @@ final class WP_Customize_Nav_Menus {
* Exports data from PHP to JS.
*
* @since 4.3.0
* @access public
*/
public function export_preview_data() {
@@ -1350,7 +1319,6 @@ final class WP_Customize_Nav_Menus {
* Export any wp_nav_menu() calls during the rendering of any partials.
*
* @since 4.5.0
* @access public
*
* @param array $response Response.
* @return array Response.
@@ -1364,7 +1332,6 @@ final class WP_Customize_Nav_Menus {
* Render a specific menu via wp_nav_menu() using the supplied arguments.
*
* @since 4.3.0
* @access public
*
* @see wp_nav_menu()
*