Changeset 30691 for trunk/src/wp-includes/widgets.php

Timestamp:

12/01/2014 07:34:25 PM (10 years ago)

Author:

DrewAPicture

Message:

Improve inline documentation for four methods in WP_Widget: get_field_id(), display_callback(), update_callback(), and form_callback().

Props jazzs3quence for the initial patch.
See #30315.

File:

• trunk/src/wp-includes/widgets.php (modified) (4 diffs)

trunk/src/wp-includes/widgets.php

@@ -133 +133 @@
 
     /**
-     * Constructs id attributes for use in form() fields
-     *
-     * 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
-     */
-    public function get_field_id($field_name) {
+     * Constructs id attributes for use in {@see WP_Widget::form()} fields.
+     *
+     * This function should be used in form() methods to create id attributes
+     * for fields to be saved by {@see WP_Widget::update()}.
+     *
+     * @since 2.8.0
+     * @access public
+     *
+     * @param string $field_name Field name.
+     * @return string ID attribute for `$field_name`.
+     */
+    public function get_field_id( $field_name ) {
         return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name;
     }
@@ -221 +225 @@
      * Finds the instance and calls {@see WP_Widget::widget()}.
      *
+     * @since 2.8.0
      * @access public
      *
@@ -274 +279 @@
 
     /**
-     * Deal with changed settings.
-     *
-     * Do NOT over-ride this function.
+     * Deal with changed settings (Do NOT override).
+     *
+     * @since 2.8.0
+     * @access public
      *
      * @param int $deprecated Not used.
@@ -356 +362 @@
 
     /**
-     * Generate the control form.
-     *
-     * Do NOT over-ride this function.
+     * Generate the widget control form (Do NOT override).
+     *
+     * @since 2.8.0
+     * @access public
+     *
+     * @param int|array $widget_args Widget instance number or array of widget arguments.
      */
     public function form_callback( $widget_args = 1 ) {