Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-11-16 15:46:04 +01:00
Code Issues Projects Releases Wiki Activity

Add some phpdoc to WP_Widget. see #8441

Browse Source 
git-svn-id: http://svn.automattic.com/wordpress/trunk@10812 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
ryan 2009-03-18 07:20:58 +00:00
parent 18c63b62aa
commit 6de4ae1ad8
1 changed files with 35 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
wp-includes/widgets.php
View File

@ -88,20 +88,34 @@ class WP_Widget {
// Member functions that you must over-ride. // Member functions that you must over-ride.
/** Echo the actual widget content. Subclasses should over-ride this function /** Echo the widget content.
* to generate their widget code. */ *
* Subclasses should over-ride this function to generate their widget code.
*
* @param array $args Display arguments including before_title, after_title, before_widget, and after_widget.
* @param array $instance The settings for the particular instance of the widget
*/
function widget($args, $instance) { function widget($args, $instance) {
die('function WP_Widget::widget() must be over-ridden in a sub-class.'); die('function WP_Widget::widget() must be over-ridden in a sub-class.');
} }
/** Update a particular instance. /** Update a particular instance.
* This function should check that $new_instance is set correctly. *
* The newly calculated value of $instance should be returned. */ * This function should check that $new_instance is set correctly.
* The newly calculated value of $instance should be returned.
*
* @param array $new_instance New settings for this instance as input by the user via form()
* @param array $old_instance Old settings for this instance
* @return array Settings to save
*/
function update($new_instance, $old_instance) { function update($new_instance, $old_instance) {
return $new_instance; return $new_instance;
} }
/** Echo a control form for the current instance. */ /** Echo the settings update form
*
* @param array $instance Current settings
*/
function form($instance) { function form($instance) {
echo '<p>' . __('There are no options for this widget.') . '</p>'; echo '<p>' . __('There are no options for this widget.') . '</p>';
} }
@ -134,20 +148,30 @@ class WP_Widget {
//add_action( 'widgets_init', array( &$this, '_register' ) ); //add_action( 'widgets_init', array( &$this, '_register' ) );
} }
/** Helper function to be called by form(). /** Constructs name attributes for use in form() fields
* Returns an HTML name for the field. */ *
* This function should be used in form() methods to create name attributes for fields to be saved by update()
*
* @param string $field_name Field name
* @return string Name attribute for $field_name
*/
function get_field_name($field_name) { function get_field_name($field_name) {
return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']'; return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']';
} }
/** Helper function to be called by form(). /** Constructs id attributes for use in form() fields
* Returns an HTML id for the field. */ *
* This function should be used in form() methods to create id attributes for fields to be saved by update()
*
* @param string $field_name Field name
* @return string ID attribute for $field_name
*/
function get_field_id($field_name) { function get_field_id($field_name) {
return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name; return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name;
} }
/** Registers this widget-type. // Private Functions. Don't worry about these.
* Called during the 'widgets_init' action. */
function _register() { function _register() {
$settings = $this->get_settings(); $settings = $this->get_settings();
@ -166,8 +190,6 @@ class WP_Widget {
} }
} }
// Private Functions. Don't worry about these.
function _set($number) { function _set($number) {
$this->number = $number; $this->number = $number;
$this->id = $this->id_base . '-' . $number; $this->id = $this->id_base . '-' . $number;