vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +00:00
Code Issues Actions 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@41162 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes
2017-07-27 00:40:27 +00:00
parent 829139ba1a
commit b4d81bd654
135 changed files with 2 additions and 1906 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
src/wp-includes/class-wp-customize-widgets.php
View File

@@ -22,7 +22,6 @@ final class WP_Customize_Widgets {
* WP_Customize_Manager instance.
*
* @since 3.9.0
* @access public
* @var WP_Customize_Manager
*/
public $manager;
@@ -31,7 +30,6 @@ final class WP_Customize_Widgets {
* All id_bases for widgets defined in core.
*
* @since 3.9.0
* @access protected
* @var array
*/
protected $core_widget_id_bases = array(
@@ -56,21 +54,18 @@ final class WP_Customize_Widgets {
/**
* @since 3.9.0
* @access protected
* @var array
*/
protected $rendered_sidebars = array();
/**
* @since 3.9.0
* @access protected
* @var array
*/
protected $rendered_widgets = array();
/**
* @since 3.9.0
* @access protected
* @var array
*/
protected $old_sidebars_widgets = array();
@@ -79,7 +74,6 @@ final class WP_Customize_Widgets {
* Mapping of widget ID base to whether it supports selective refresh.
*
* @since 4.5.0
* @access protected
* @var array
*/
protected $selective_refreshable_widgets;
@@ -88,7 +82,6 @@ final class WP_Customize_Widgets {
* Mapping of setting type to setting ID pattern.
*
* @since 4.2.0
* @access protected
* @var array
*/
protected $setting_id_patterns = array(
@@ -100,7 +93,6 @@ final class WP_Customize_Widgets {
* Initial loader.
*
* @since 3.9.0
* @access public
*
* @param WP_Customize_Manager $manager Customize manager bootstrap instance.
*/
@@ -143,7 +135,6 @@ final class WP_Customize_Widgets {
* then this will always return an empty array.
*
* @since 4.5.0
* @access public
*
* @global WP_Widget_Factory $wp_widget_factory
*
@@ -168,7 +159,6 @@ final class WP_Customize_Widgets {
* Determines if a widget supports selective refresh.
*
* @since 4.5.0
* @access public
*
* @param string $id_base Widget ID Base.
* @return bool Whether the widget can be selective refreshed.
@@ -182,7 +172,6 @@ final class WP_Customize_Widgets {
* Retrieves the widget setting type given a setting ID.
*
* @since 4.2.0
* @access protected
*
* @staticvar array $cache
*
@@ -207,7 +196,6 @@ final class WP_Customize_Widgets {
* them up-front so widgets will be initialized properly.
*
* @since 4.2.0
* @access public
*/
public function register_settings() {
$widget_setting_ids = array();
@@ -239,7 +227,6 @@ final class WP_Customize_Widgets {
* Determines the arguments for a dynamically-created setting.
*
* @since 4.2.0
* @access public
*
* @param false|array $args The arguments to the WP_Customize_Setting constructor.
* @param string $setting_id ID for dynamic setting, usually coming from `$_POST['customized']`.
@@ -256,7 +243,6 @@ final class WP_Customize_Widgets {
* Retrieves an unslashed post value or return a default.
*
* @since 3.9.0
* @access protected
*
* @param string $name Post value.
* @param mixed $default Default post value.
@@ -280,7 +266,6 @@ final class WP_Customize_Widgets {
* theme gets switched.
*
* @since 3.9.0
* @access public
*
* @global array $sidebars_widgets
* @global array $_wp_sidebars_widgets
@@ -313,7 +298,6 @@ final class WP_Customize_Widgets {
* theme_mod.
*
* @since 3.9.0
* @access public
*
* @see WP_Customize_Widgets::handle_theme_switch()
*
@@ -332,7 +316,6 @@ final class WP_Customize_Widgets {
* option.
*
* @since 3.9.0
* @access public
*
* @see WP_Customize_Widgets::handle_theme_switch()
* @global array $sidebars_widgets
@@ -352,7 +335,6 @@ final class WP_Customize_Widgets {
* Note: these actions are also fired in wp_ajax_update_widget().
*
* @since 3.9.0
* @access public
*/
public function customize_controls_init() {
/** This action is documented in wp-admin/includes/ajax-actions.php */
@@ -372,7 +354,6 @@ final class WP_Customize_Widgets {
* so that all filters have been initialized (e.g. Widget Visibility).
*
* @since 3.9.0
* @access public
*/
public function schedule_customize_register() {
if ( is_admin() ) {
@@ -386,7 +367,6 @@ final class WP_Customize_Widgets {
* Registers Customizer settings and controls for all sidebars and widgets.
*
* @since 3.9.0
* @access public
*
* @global array $wp_registered_widgets
* @global array $wp_registered_widget_controls
@@ -537,7 +517,6 @@ final class WP_Customize_Widgets {
* Determines whether the widgets panel is active, based on whether there are sidebars registered.
*
* @since 4.4.0
* @access public
*
* @see WP_Customize_Panel::$active_callback
*
@@ -553,7 +532,6 @@ final class WP_Customize_Widgets {
* Converts a widget_id into its corresponding Customizer setting ID (option name).
*
* @since 3.9.0
* @access public
*
* @param string $widget_id Widget ID.
* @return string Maybe-parsed widget ID.
@@ -579,7 +557,6 @@ final class WP_Customize_Widgets {
* overridden with the {@see 'is_wide_widget_in_customizer'} filter.
*
* @since 3.9.0
* @access public
*
* @global $wp_registered_widget_controls
*
@@ -609,7 +586,6 @@ final class WP_Customize_Widgets {
* Converts a widget ID into its id_base and number components.
*
* @since 3.9.0
* @access public
*
* @param string $widget_id Widget ID.
* @return array Array containing a widget's id_base and number components.
@@ -634,7 +610,6 @@ final class WP_Customize_Widgets {
* Converts a widget setting ID (option path) to its id_base and number components.
*
* @since 3.9.0
* @access public
*
* @param string $setting_id Widget setting ID.
* @return WP_Error|array Array containing a widget's id_base and number components,
@@ -656,7 +631,6 @@ final class WP_Customize_Widgets {
* allow custom styles from plugins.
*
* @since 3.9.0
* @access public
*/
public function print_styles() {
/** This action is documented in wp-admin/admin-header.php */
@@ -671,7 +645,6 @@ final class WP_Customize_Widgets {
* allow custom scripts from plugins.
*
* @since 3.9.0
* @access public
*/
public function print_scripts() {
/** This action is documented in wp-admin/admin-header.php */
@@ -685,7 +658,6 @@ final class WP_Customize_Widgets {
* Enqueues scripts and styles for Customizer panel and export data to JavaScript.
*
* @since 3.9.0
* @access public
*
* @global WP_Scripts $wp_scripts
* @global array $wp_registered_sidebars
@@ -822,7 +794,6 @@ final class WP_Customize_Widgets {
* Renders the widget form control templates into the DOM.
*
* @since 3.9.0
* @access public
*/
public function output_widget_control_templates() {
?>
@@ -865,7 +836,6 @@ final class WP_Customize_Widgets {
* allow custom scripts from plugins.
*
* @since 3.9.0
* @access public
*/
public function print_footer_scripts() {
/** This action is documented in wp-admin/admin-footer.php */
@@ -882,7 +852,6 @@ final class WP_Customize_Widgets {
* Retrieves common arguments to supply when constructing a Customizer setting.
*
* @since 3.9.0
* @access public
*
* @param string $id Widget setting ID.
* @param array $overrides Array of setting overrides.
@@ -926,7 +895,6 @@ final class WP_Customize_Widgets {
* Used as the 'sanitize_callback' for each $sidebars_widgets setting.
*
* @since 3.9.0
* @access public
*
* @param array $widget_ids Array of widget IDs.
* @return array Array of sanitized widget IDs.
@@ -944,7 +912,6 @@ final class WP_Customize_Widgets {
* Builds up an index of all available widgets for use in Backbone models.
*
* @since 3.9.0
* @access public
*
* @global array $wp_registered_widgets
* @global array $wp_registered_widget_controls
@@ -1031,7 +998,6 @@ final class WP_Customize_Widgets {
* Naturally orders available widgets by name.
*
* @since 3.9.0
* @access protected
*
* @param array $widget_a The first widget to compare.
* @param array $widget_b The second widget to compare.
@@ -1045,7 +1011,6 @@ final class WP_Customize_Widgets {
* Retrieves the widget control markup.
*
* @since 3.9.0
* @access public
*
* @param array $args Widget control arguments.
* @return string Widget control form HTML markup.
@@ -1065,7 +1030,6 @@ final class WP_Customize_Widgets {
* Retrieves the widget control markup parts.
*
* @since 4.4.0
* @access public
*
* @param array $args Widget control arguments.
* @return array {
@@ -1096,7 +1060,6 @@ final class WP_Customize_Widgets {
* Adds hooks for the Customizer preview.
*
* @since 3.9.0
* @access public
*/
public function customize_preview_init() {
add_action( 'wp_enqueue_scripts', array( $this, 'customize_preview_enqueue' ) );
@@ -1108,7 +1071,6 @@ final class WP_Customize_Widgets {
* Refreshes the nonce for widget updates.
*
* @since 4.2.0
* @access public
*
* @param array $nonces Array of nonces.
* @return array $nonces Array of nonces.
@@ -1127,7 +1089,6 @@ final class WP_Customize_Widgets {
* filter is added, it has to be reset after the filter has been added.
*
* @since 3.9.0
* @access public
*
* @param array $sidebars_widgets List of widgets for the current sidebar.
* @return array
@@ -1143,7 +1104,6 @@ final class WP_Customize_Widgets {
* Enqueues scripts for the Customizer preview.
*
* @since 3.9.0
* @access public
*/
public function customize_preview_enqueue() {
wp_enqueue_script( 'customize-preview-widgets' );
@@ -1154,7 +1114,6 @@ final class WP_Customize_Widgets {
* stylesheet can override.
*
* @since 3.9.0
* @access public
*/
public function print_preview_css() {
?>
@@ -1215,7 +1174,6 @@ final class WP_Customize_Widgets {
* Tracks the widgets that were rendered.
*
* @since 3.9.0
* @access public
*
* @param array $widget Rendered widget to tally.
*/
@@ -1227,7 +1185,6 @@ final class WP_Customize_Widgets {
* Determine if a widget is rendered on the page.
*
* @since 4.0.0
* @access public
*
* @param string $widget_id Widget ID to check.
* @return bool Whether the widget is rendered.
@@ -1240,7 +1197,6 @@ final class WP_Customize_Widgets {
* Determines if a sidebar is rendered on the page.
*
* @since 4.0.0
* @access public
*
* @param string $sidebar_id Sidebar ID to check.
* @return bool Whether the sidebar is rendered.
@@ -1257,7 +1213,6 @@ final class WP_Customize_Widgets {
* if there were widgets populating it.
*
* @since 3.9.0
* @access public
*
* @param bool $is_active Whether the sidebar is active.
* @param string $sidebar_id Sidebar ID.
@@ -1283,7 +1238,6 @@ final class WP_Customize_Widgets {
* there were widgets populating it.
*
* @since 3.9.0
* @access public
*
* @param bool $has_widgets Whether the current sidebar has widgets.
* @param string $sidebar_id Sidebar ID.
@@ -1309,7 +1263,6 @@ final class WP_Customize_Widgets {
* data has occurred.
*
* @since 3.9.0
* @access protected
*
* @param string $serialized_instance Widget instance.
* @return string MAC for serialized widget instance.
@@ -1325,7 +1278,6 @@ final class WP_Customize_Widgets {
* only get applied to an instance *once*.
*
* @since 3.9.0
* @access public
*
* @param array $value Widget instance to sanitize.
* @return array|void Sanitized widget instance.
@@ -1363,7 +1315,6 @@ final class WP_Customize_Widgets {
* Converts a widget instance into JSON-representable format.
*
* @since 3.9.0
* @access public
*
* @param array $value Widget instance to convert to JSON.
* @return array JSON-converted widget instance.
@@ -1389,7 +1340,6 @@ final class WP_Customize_Widgets {
* in a sidebar upon deactivation.
*
* @since 3.9.0
* @access public
*
* @global array $wp_registered_widgets
*
@@ -1408,7 +1358,6 @@ final class WP_Customize_Widgets {
* Requires that `$_POST` be populated with the instance data.
*
* @since 3.9.0
* @access public
*
* @global array $wp_registered_widget_updates
* @global array $wp_registered_widget_controls
@@ -1538,7 +1487,6 @@ final class WP_Customize_Widgets {
* Most code here copied from wp_ajax_save_widget().
*
* @since 3.9.0
* @access public
*
* @see wp_ajax_save_widget()
*/
@@ -1601,7 +1549,6 @@ final class WP_Customize_Widgets {
* Filters arguments for dynamic widget partials.
*
* @since 4.5.0
* @access public
*
* @param array|false $partial_args Partial arguments.
* @param string $partial_id Partial ID.
@@ -1635,7 +1582,6 @@ final class WP_Customize_Widgets {
* Adds hooks for selective refresh.
*
* @since 4.5.0
* @access public
*/
public function selective_refresh_init() {
if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) {
@@ -1711,7 +1657,6 @@ final class WP_Customize_Widgets {
* data-* attributes can be whitelisted.
*
* @since 4.5.0
* @access protected
* @var array
*/
protected $before_widget_tags_seen = array();
@@ -1722,7 +1667,6 @@ final class WP_Customize_Widgets {
* This is needed in case the `$before_widget` is run through wp_kses() when printed.
*
* @since 4.5.0
* @access public
*
* @param array $allowed_html Allowed HTML.
* @return array (Maybe) modified allowed HTML.
@@ -1752,7 +1696,6 @@ final class WP_Customize_Widgets {
* This helps facilitate the uncommon scenario where a single sidebar is rendered multiple times on a template.
*
* @since 4.5.0
* @access protected
* @var array
*/
protected $sidebar_instance_count = array();
@@ -1761,7 +1704,6 @@ final class WP_Customize_Widgets {
* The current request's sidebar_instance_number context.
*
* @since 4.5.0
* @access protected
* @var int
*/
protected $context_sidebar_instance_number;
@@ -1770,7 +1712,6 @@ final class WP_Customize_Widgets {
* Current sidebar ID being rendered.
*
* @since 4.5.0
* @access protected
* @var array
*/
protected $current_dynamic_sidebar_id_stack = array();
@@ -1781,7 +1722,6 @@ final class WP_Customize_Widgets {
* Insert marker before widgets are rendered in a dynamic sidebar.
*
* @since 4.5.0
* @access public
*
* @param int|string $index Index, name, or ID of the dynamic sidebar.
*/
@@ -1802,7 +1742,6 @@ final class WP_Customize_Widgets {
* Inserts a marker after widgets are rendered in a dynamic sidebar.
*
* @since 4.5.0
* @access public
*
* @param int|string $index Index, name, or ID of the dynamic sidebar.
*/
@@ -1817,7 +1756,6 @@ final class WP_Customize_Widgets {
* Current sidebar being rendered.
*
* @since 4.5.0
* @access protected
* @var string
*/
protected $rendering_widget_id;
@@ -1826,7 +1764,6 @@ final class WP_Customize_Widgets {
* Current widget being rendered.
*
* @since 4.5.0
* @access protected
* @var string
*/
protected $rendering_sidebar_id;
@@ -1835,7 +1772,6 @@ final class WP_Customize_Widgets {
* Filters sidebars_widgets to ensure the currently-rendered widget is the only widget in the current sidebar.
*
* @since 4.5.0
* @access protected
*
* @param array $sidebars_widgets Sidebars widgets.
* @return array Filtered sidebars widgets.
@@ -1849,7 +1785,6 @@ final class WP_Customize_Widgets {
* Renders a specific widget using the supplied sidebar arguments.
*
* @since 4.5.0
* @access public
*
* @see dynamic_sidebar()
*
@@ -1908,7 +1843,6 @@ final class WP_Customize_Widgets {
* List of captured widget option updates.
*
* @since 3.9.0
* @access protected
* @var array $_captured_options Values updated while option capture is happening.
*/
protected $_captured_options = array();
@@ -1917,7 +1851,6 @@ final class WP_Customize_Widgets {
* Whether option capture is currently happening.
*
* @since 3.9.0
* @access protected
* @var bool $_is_current Whether option capture is currently happening or not.
*/
protected $_is_capturing_option_updates = false;
@@ -1926,7 +1859,6 @@ final class WP_Customize_Widgets {
* Determines whether the captured option update should be ignored.
*
* @since 3.9.0
* @access protected
*
* @param string $option_name Option name.
* @return bool Whether the option capture is ignored.
@@ -1939,7 +1871,6 @@ final class WP_Customize_Widgets {
* Retrieves captured widget option updates.
*
* @since 3.9.0
* @access protected
*
* @return array Array of captured options.
*/
@@ -1951,7 +1882,6 @@ final class WP_Customize_Widgets {
* Retrieves the option that was captured from being saved.
*
* @since 4.2.0
* @access protected
*
* @param string $option_name Option name.
* @param mixed $default Optional. Default value to return if the option does not exist. Default false.
@@ -1970,7 +1900,6 @@ final class WP_Customize_Widgets {
* Retrieves the number of captured widget option updates.
*
* @since 3.9.0
* @access protected
*
* @return int Number of updated options.
*/
@@ -1982,7 +1911,6 @@ final class WP_Customize_Widgets {
* Begins keeping track of changes to widget options, caching new values.
*
* @since 3.9.0
* @access protected
*/
protected function start_capturing_option_updates() {
if ( $this->_is_capturing_option_updates ) {
@@ -1998,7 +1926,6 @@ final class WP_Customize_Widgets {
* Pre-filters captured option values before updating.
*
* @since 3.9.0
* @access public
*
* @param mixed $new_value The new option value.
* @param string $option_name Name of the option.
@@ -2023,7 +1950,6 @@ final class WP_Customize_Widgets {
* Pre-filters captured option values before retrieving.
*
* @since 3.9.0
* @access public
*
* @param mixed $value Value to return instead of the option value.
* @return mixed Filtered option value.
@@ -2045,7 +1971,6 @@ final class WP_Customize_Widgets {
* Undoes any changes to the options since options capture began.
*
* @since 3.9.0
* @access protected
*/
protected function stop_capturing_option_updates() {
if ( ! $this->_is_capturing_option_updates ) {