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

28
src/wp-includes/class-wp-widget.php
View File

@@ -23,7 +23,6 @@ class WP_Widget {
* Root ID for all widgets of this type.
*
* @since 2.8.0
* @access public
* @var mixed|string
*/
public $id_base;
@@ -32,7 +31,6 @@ class WP_Widget {
* Name for this widget type.
*
* @since 2.8.0
* @access public
* @var string
*/
public $name;
@@ -41,7 +39,6 @@ class WP_Widget {
* Option name for this widget type.
*
* @since 2.8.0
* @access public
* @var string
*/
public $option_name;
@@ -50,7 +47,6 @@ class WP_Widget {
* Alt option name for this widget type.
*
* @since 2.8.0
* @access public
* @var string
*/
public $alt_option_name;
@@ -59,7 +55,6 @@ class WP_Widget {
* Option array passed to wp_register_sidebar_widget().
*
* @since 2.8.0
* @access public
* @var array
*/
public $widget_options;
@@ -68,7 +63,6 @@ class WP_Widget {
* Option array passed to wp_register_widget_control().
*
* @since 2.8.0
* @access public
* @var array
*/
public $control_options;
@@ -77,7 +71,6 @@ class WP_Widget {
* Unique ID number of the current instance.
*
* @since 2.8.0
* @access public
* @var bool|int
*/
public $number = false;
@@ -86,7 +79,6 @@ class WP_Widget {
* Unique ID string of the current instance (id_base-number).
*
* @since 2.8.0
* @access public
* @var bool|string
*/
public $id = false;
@@ -98,7 +90,6 @@ class WP_Widget {
* not happen twice.
*
* @since 2.8.0
* @access public
* @var bool
*/
public $updated = false;
@@ -113,7 +104,6 @@ class WP_Widget {
* Sub-classes should over-ride this function to generate their widget code.
*
* @since 2.8.0
* @access public
*
* @param array $args Display arguments including 'before_title', 'after_title',
* 'before_widget', and 'after_widget'.
@@ -131,7 +121,6 @@ class WP_Widget {
* saved/updated.
*
* @since 2.8.0
* @access public
*
* @param array $new_instance New settings for this instance as input by the user via
* WP_Widget::form().
@@ -146,7 +135,6 @@ class WP_Widget {
* Outputs the settings update form.
*
* @since 2.8.0
* @access public
*
* @param array $instance Current settings.
* @return string Default return is 'noform'.
@@ -162,7 +150,6 @@ class WP_Widget {
* PHP5 constructor.
*
* @since 2.8.0
* @access public
*
* @param string $id_base Optional Base ID for the widget, lowercase and unique. If left empty,
* a portion of the widget's class name will be used Has to be unique.
@@ -184,7 +171,6 @@ class WP_Widget {
* PHP4 constructor.
*
* @since 2.8.0
* @access public
*
* @see __construct()
*
@@ -209,7 +195,6 @@ class WP_Widget {
*
* @since 2.8.0
* @since 4.4.0 Array format field names are now accepted.
* @access public
*
* @param string $field_name Field name
* @return string Name attribute for $field_name
@@ -230,7 +215,6 @@ class WP_Widget {
*
* @since 2.8.0
* @since 4.4.0 Array format field IDs are now accepted.
* @access public
*
* @param string $field_name Field name.
* @return string ID attribute for `$field_name`.
@@ -243,7 +227,6 @@ class WP_Widget {
* Register all widget instances of this widget class.
*
* @since 2.8.0
* @access public
*/
public function _register() {
$settings = $this->get_settings();
@@ -275,7 +258,6 @@ class WP_Widget {
* Sets the internal order number for the widget instance.
*
* @since 2.8.0
* @access public
*
* @param int $number The unique order number of this widget instance compared to other
* instances of the same class.
@@ -289,7 +271,6 @@ class WP_Widget {
* Retrieves the widget display callback.
*
* @since 2.8.0
* @access public
*
* @return callable Display callback.
*/
@@ -301,7 +282,6 @@ class WP_Widget {
* Retrieves the widget update callback.
*
* @since 2.8.0
* @access public
*
* @return callable Update callback.
*/
@@ -313,7 +293,6 @@ class WP_Widget {
* Retrieves the form callback.
*
* @since 2.8.0
* @access public
*
* @return callable Form callback.
*/
@@ -330,7 +309,6 @@ class WP_Widget {
* to transients, or anywhere else.
*
* @since 3.9.0
* @access public
*
* @global WP_Customize_Manager $wp_customize
*
@@ -347,7 +325,6 @@ class WP_Widget {
* Finds the instance and calls WP_Widget::widget().
*
* @since 2.8.0
* @access public
*
* @param array $args Display arguments. See WP_Widget::widget() for information
* on accepted arguments.
@@ -404,7 +381,6 @@ class WP_Widget {
* Handles changed settings (Do NOT override).
*
* @since 2.8.0
* @access public
*
* @global array $wp_registered_widgets
*
@@ -489,7 +465,6 @@ class WP_Widget {
* Generates the widget control form (Do NOT override).
*
* @since 2.8.0
* @access public
*
* @param int|array $widget_args {
* Optional. Internal order number of the widget instance, or array of multi-widget arguments.
@@ -556,7 +531,6 @@ class WP_Widget {
* Registers an instance of the widget class.
*
* @since 2.8.0
* @access public
*
* @param integer $number Optional. The unique order number of this widget instance
* compared to other instances of the same class. Default -1.
@@ -571,7 +545,6 @@ class WP_Widget {
* Saves the settings for all instances of the widget class.
*
* @since 2.8.0
* @access public
*
* @param array $settings Multi-dimensional array of widget instance settings.
*/
@@ -584,7 +557,6 @@ class WP_Widget {
* Retrieves the settings for all instances of the widget class.
*
* @since 2.8.0
* @access public
*
* @return array Multi-dimensional array of widget instance settings.
*/