Changeset 13098

Timestamp:

02/13/2010 07:55:28 AM (13 years ago)

Author:

nacin

Message:

Move deprecated pre-2.8 widget API to deprecated.php. Deprecate register_sidebar_widget, unregister_sidebar_widget, register_widget_control, unregister_widget_control, in favor of their wp_* counterparts. See #11388

Location:

trunk/wp-includes

Files:

• deprecated.php (modified) (1 diff)
• widgets.php (modified) (1 diff)

trunk/wp-includes/deprecated.php

@@ -2192 +2192 @@
 }
 
+/**
+ * Register widget for sidebar with backwards compatibility.
+ *
+ * Allows $name to be an array that accepts either three elements to grab the
+ * first element and the third for the name or just uses the first element of
+ * the array for the name.
+ *
+ * Passes to {@link wp_register_sidebar_widget()} after argument list and
+ * backwards compatibility is complete.
+ *
+ * @since 2.2.0
+ * @deprecated 2.8.0
+ * @deprecated Use wp_register_sidebar_widget()
+ * @see wp_register_sidebar_widget()
+ *
+ * @param string|int $name Widget ID.
+ * @param callback $output_callback Run when widget is called.
+ * @param string $classname Classname widget option.
+ * @param mixed $params,... Widget parameters.
+ */
+function register_sidebar_widget($name, $output_callback, $classname = '') {
+    _deprecated_function( __FUNCTION__, '2.8', 'wp_register_sidebar_widget()' );
+    // Compat
+    if ( is_array($name) ) {
+        if ( count($name) == 3 )
+            $name = sprintf($name[0], $name[2]);
+        else
+            $name = $name[0];
+    }
+
+    $id = sanitize_title($name);
+    $options = array();
+    if ( !empty($classname) && is_string($classname) )
+        $options['classname'] = $classname;
+    $params = array_slice(func_get_args(), 2);
+    $args = array($id, $name, $output_callback, $options);
+    if ( !empty($params) )
+        $args = array_merge($args, $params);
+
+    call_user_func_array('wp_register_sidebar_widget', $args);
+}
+
+/**
+ * Alias of {@link wp_unregister_sidebar_widget()}.
+ *
+ * @since 2.2.0
+ * @deprecated 2.8.0
+ * @deprecated Use wp_unregister_sidebar_widget()
+ * @see wp_unregister_sidebar_widget()
+ *
+ * @param int|string $id Widget ID.
+ */
+function unregister_sidebar_widget($id) {
+    _deprecated_function( __FUNCTION__, '2.8', 'wp_unregister_sidebar_widget()' );
+    return wp_unregister_sidebar_widget($id);
+}
+
+/**
+ * Registers widget control callback for customizing options.
+ *
+ * Allows $name to be an array that accepts either three elements to grab the
+ * first element and the third for the name or just uses the first element of
+ * the array for the name.
+ *
+ * Passes to {@link wp_register_widget_control()} after the argument list has
+ * been compiled.
+ *
+ * @since 2.2.0
+ * @deprecated 2.8.0
+ * @deprecated Use wp_register_widget_control()
+ * @see wp_register_widget_control()
+ *
+ * @param int|string $name Sidebar ID.
+ * @param callback $control_callback Widget control callback to display and process form.
+ * @param int $width Widget width.
+ * @param int $height Widget height.
+ */
+function register_widget_control($name, $control_callback, $width = '', $height = '') {
+    _deprecated_function( __FUNCTION__, '2.8', 'wp_register_widget_control()' );
+    // Compat
+    if ( is_array($name) ) {
+        if ( count($name) == 3 )
+            $name = sprintf($name[0], $name[2]);
+        else
+            $name = $name[0];
+    }
+
+    $id = sanitize_title($name);
+    $options = array();
+    if ( !empty($width) )
+        $options['width'] = $width;
+    if ( !empty($height) )
+        $options['height'] = $height;
+    $params = array_slice(func_get_args(), 4);
+    $args = array($id, $name, $control_callback, $options);
+    if ( !empty($params) )
+        $args = array_merge($args, $params);
+
+    call_user_func_array('wp_register_widget_control', $args);
+}
+
+/**
+ * Alias of {@link wp_unregister_widget_control()}.
+ *
+ * @since 2.2.0
+ * @deprecated 2.8.0
+ * @deprecated Use wp_unregister_widget_control()
+ * @see wp_unregister_widget_control()
+ *
+ * @param int|string $id Widget ID.
+ */
+function unregister_widget_control($id) {
+    _deprecated_function( __FUNCTION__, '2.8', 'wp_unregister_widget_control()' );
+    return wp_unregister_widget_control($id);
+}
+
 ?>

trunk/wp-includes/widgets.php

@@ -1172 +1172 @@
 
 /**
- * Deprecated API
- */
-
-/**
- * Register widget for sidebar with backwards compatibility.
- *
- * Allows $name to be an array that accepts either three elements to grab the
- * first element and the third for the name or just uses the first element of
- * the array for the name.
- *
- * Passes to {@link wp_register_sidebar_widget()} after argument list and
- * backwards compatibility is complete.
- *
- * @since 2.2.0
- * @uses wp_register_sidebar_widget() Passes the compiled arguments.
- *
- * @param string|int $name Widget ID.
- * @param callback $output_callback Run when widget is called.
- * @param string $classname Classname widget option.
- * @param mixed $params,... Widget parameters.
- */
-function register_sidebar_widget($name, $output_callback, $classname = '') {
-    // Compat
-    if ( is_array($name) ) {
-        if ( count($name) == 3 )
-            $name = sprintf($name[0], $name[2]);
-        else
-            $name = $name[0];
-    }
-
-    $id = sanitize_title($name);
-    $options = array();
-    if ( !empty($classname) && is_string($classname) )
-        $options['classname'] = $classname;
-    $params = array_slice(func_get_args(), 2);
-    $args = array($id, $name, $output_callback, $options);
-    if ( !empty($params) )
-        $args = array_merge($args, $params);
-
-    call_user_func_array('wp_register_sidebar_widget', $args);
-}
-
-/**
- * Alias of {@link wp_unregister_sidebar_widget()}.
- *
- * @see wp_unregister_sidebar_widget()
- *
- * @since 2.2.0
- *
- * @param int|string $id Widget ID.
- */
-function unregister_sidebar_widget($id) {
-    return wp_unregister_sidebar_widget($id);
-}
-
-/**
- * Registers widget control callback for customizing options.
- *
- * Allows $name to be an array that accepts either three elements to grab the
- * first element and the third for the name or just uses the first element of
- * the array for the name.
- *
- * Passes to {@link wp_register_widget_control()} after the argument list has
- * been compiled.
- *
- * @since 2.2.0
- *
- * @param int|string $name Sidebar ID.
- * @param callback $control_callback Widget control callback to display and process form.
- * @param int $width Widget width.
- * @param int $height Widget height.
- */
-function register_widget_control($name, $control_callback, $width = '', $height = '') {
-    // Compat
-    if ( is_array($name) ) {
-        if ( count($name) == 3 )
-            $name = sprintf($name[0], $name[2]);
-        else
-            $name = $name[0];
-    }
-
-    $id = sanitize_title($name);
-    $options = array();
-    if ( !empty($width) )
-        $options['width'] = $width;
-    if ( !empty($height) )
-        $options['height'] = $height;
-    $params = array_slice(func_get_args(), 4);
-    $args = array($id, $name, $control_callback, $options);
-    if ( !empty($params) )
-        $args = array_merge($args, $params);
-
-    call_user_func_array('wp_register_widget_control', $args);
-}
-
-/**
- * Alias of {@link wp_unregister_widget_control()}.
- *
- * @since 2.2.0
- * @see wp_unregister_widget_control()
- *
- * @param int|string $id Widget ID.
- */
-function unregister_widget_control($id) {
-    return wp_unregister_widget_control($id);
-}
-
-/**
  * Output an arbitrary widget as a template tag
  *