Changeset 30774

Timestamp:

12/07/2014 08:07:05 PM (11 years ago)

Author:

DrewAPicture

Message:

Introduce documentation for three methods in WP_Widget_Factory: register(), unregister(), _register_widgets().

See #30315.

File:

• trunk/src/wp-includes/widgets.php (modified) (1 diff)

trunk/src/wp-includes/widgets.php

@@ -549 +549 @@
     }
 
-    public function register($widget_class) {
+    /**
+     * Register a widget subclass.
+     *
+     * @since 2.8.0
+     * @access public
+     *
+     * @param string $widget_class The name of a {@see WP_Widget} subclass.
+     */
+    public function register( $widget_class ) {
         $this->widgets[$widget_class] = new $widget_class();
     }
 
-    public function unregister($widget_class) {
+    /**
+     * Un-register a widget subclass.
+     *
+     * @since 2.8.0
+     * @access public
+     *
+     * @param string $widget_class The name of a {@see WP_Widget} subclass.
+     */
+    public function unregister( $widget_class ) {
         if ( isset($this->widgets[$widget_class]) )
             unset($this->widgets[$widget_class]);
     }
 
+    /**
+     * Utility method for adding widgets to the registered widgets global.
+     *
+     * @since 2.8.0
+     * @access public
+     */
     public function _register_widgets() {
         global $wp_registered_widgets;