mirror_php/wordpress
1
0
Fork 0
mirror of git://develop.git.wordpress.org/ synced 2025-02-24 00:24:52 +01:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

Introduce documentation for the $id_base, $name, $widget_options, $control_options, $number, $id, and $updated properties in `WP_Widget'.

Browse Source 
See #30315.


git-svn-id: https://develop.svn.wordpress.org/trunk@30773 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-12-07 20:04:43 +00:00
parent ac47dd2cd0
commit 3c1a8e1407
1 changed files with 64 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
src/wp-includes/widgets.php
View File

@ -23,14 +23,71 @@
*/
class WP_Widget {
public $id_base; // Root id for all widgets of this type.
public $name; // Name for this widget type.
public $widget_options; // Option array passed to wp_register_sidebar_widget()
public $control_options; // Option array passed to wp_register_widget_control()
/**
* Root ID for all widgets of this type.
*
* @since 2.8.0
* @access public
* @var mixed|string
*/
public $id_base;
public $number = false; // Unique ID number of the current instance.
public $id = false; // Unique ID string of the current instance (id_base-number)
public $updated = false; // Set true when we update the data after a POST submit - makes sure we don't do it twice.
/**
* Name for this widget type.
*
* @since 2.8.0
* @access public
* @var string
*/
public $name;
/**
* Option array passed to {@see wp_register_sidebar_widget()}.
*
* @since 2.8.0
* @access public
* @var array
*/
public $widget_options;
/**
* Option array passed to {@see wp_register_widget_control()}.
*
* @since 2.8.0
* @access public
* @var array
*/
public $control_options;
/**
* Unique ID number of the current instance.
*
* @since 2.8.0
* @access public
* @var bool|int
*/
public $number = false;
/**
* Unique ID string of the current instance (id_base-number).
*
* @since 2.8.0
* @access public
* @var bool|string
*/
public $id = false;
/**
* Whether the widget data has been updated.
*
* Set to true when the data is updated after a POST submit - ensures it does
* not happen twice.
*
* @since 2.8.0
* @access public
* @var bool
*/
public $updated = false;
// Member functions that you must over-ride.