sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Add missing information to the WP_Widget PHP4 constructor DocBlock.

Browse Source 
Also add several missing at `@access` tags to other method DocBlocks and clarify parameter docs for `WP_Widget::form_callback()`.

Props raimy.
See #36298.


git-svn-id: https://develop.svn.wordpress.org/trunk@37064 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-03-23 05:09:48 +00:00
parent cbf08027df
commit 43dfcc5fa8
1 changed files with 25 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -162,10 +162,18 @@ class WP_Widget {
/** /**
* PHP4 constructor. * PHP4 constructor.
* *
* @param string $id_base * @since 2.8.0
* @param string $name * @access public
* @param array $widget_options *
* @param array $control_options * @see __construct()
*
* @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.
* @param string $name Name for the widget displayed on the configuration page.
* @param array $widget_options Optional. Widget options. See wp_register_sidebar_widget() for information
* on accepted arguments. Default empty array.
* @param array $control_options Optional. Widget control options. See wp_register_widget_control() for
* information on accepted arguments. Default empty array.
*/ */
public function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) { public function WP_Widget( $id_base, $name, $widget_options = array(), $control_options = array() ) {
_deprecated_constructor( 'WP_Widget', '4.3.0', get_class( $this ) ); _deprecated_constructor( 'WP_Widget', '4.3.0', get_class( $this ) );
@ -179,6 +187,7 @@ class WP_Widget {
* *
* @since 2.8.0 * @since 2.8.0
* @since 4.4.0 Array format field names are now accepted. * @since 4.4.0 Array format field names are now accepted.
* @access public
* *
* @param string $field_name Field name * @param string $field_name Field name
* @return string Name attribute for $field_name * @return string Name attribute for $field_name
@ -212,7 +221,7 @@ class WP_Widget {
* Register all widget instances of this widget class. * Register all widget instances of this widget class.
* *
* @since 2.8.0 * @since 2.8.0
* @access private * @access public
*/ */
public function _register() { public function _register() {
$settings = $this->get_settings(); $settings = $this->get_settings();
@ -244,7 +253,7 @@ class WP_Widget {
* Set the internal order number for the widget instance. * Set the internal order number for the widget instance.
* *
* @since 2.8.0 * @since 2.8.0
* @access private * @access public
* *
* @param int $number The unique order number of this widget instance compared to other * @param int $number The unique order number of this widget instance compared to other
* instances of the same class. * instances of the same class.
@ -258,6 +267,7 @@ class WP_Widget {
* Retrieves the widget display callback. * Retrieves the widget display callback.
* *
* @since 2.8.0 * @since 2.8.0
* @access public
* *
* @return callable Display callback. * @return callable Display callback.
*/ */
@ -269,6 +279,7 @@ class WP_Widget {
* Retrieves the widget update callback. * Retrieves the widget update callback.
* *
* @since 2.8.0 * @since 2.8.0
* @access public
* *
* @return callable Update callback. * @return callable Update callback.
*/ */
@ -280,6 +291,7 @@ class WP_Widget {
* Retrieves the form callback. * Retrieves the form callback.
* *
* @since 2.8.0 * @since 2.8.0
* @access public
* *
* @return callable Form callback. * @return callable Form callback.
*/ */
@ -457,7 +469,12 @@ class WP_Widget {
* @since 2.8.0 * @since 2.8.0
* @access public * @access public
* *
* @param int|array $widget_args Widget instance number or array of widget arguments. * @param int|array $widget_args {
* Optional. Internal order number of the widget instance, or array of multi-widget arguments.
* Default 1.
*
* @type int $number Number increment used for multiples of the same widget.
* }
* @return string|null * @return string|null
*/ */
public function form_callback( $widget_args = 1 ) { public function form_callback( $widget_args = 1 ) {
@ -517,7 +534,7 @@ class WP_Widget {
* Register an instance of the widget class. * Register an instance of the widget class.
* *
* @since 2.8.0 * @since 2.8.0
* @access private * @access public
* *
* @param integer $number Optional. The unique order number of this widget instance * @param integer $number Optional. The unique order number of this widget instance
* compared to other instances of the same class. Default -1. * compared to other instances of the same class. Default -1.