Changeset 19520 for trunk/wp-admin/includes/deprecated.php

Timestamp:

12/01/2011 03:29:55 AM (14 years ago)

Author:

nacin

Message:

Deprecate add_contextual_help() for get_current_screen()->add_help_tab(). fixes #19020.

File:

• trunk/wp-admin/includes/deprecated.php (modified) (1 diff)

trunk/wp-admin/includes/deprecated.php

@@ -860 +860 @@
     return wp_media_insert_url_form( 'file' );
 }
+
+/**
+ * Add contextual help text for a page.
+ *
+ * Creates an 'Overview' help tab.
+ *
+ * @since 2.7.0
+ * @deprecated 3.3.0
+ * @deprecated Use get_current_screen()->add_help_tab()
+ * @see WP_Screen
+ *
+ * @param string    $screen The handle for the screen to add help to.  This is usually the hook name returned by the add_*_page() functions.
+ * @param string    $help   The content of an 'Overview' help tab.
+ */
+function add_contextual_help( $screen, $help ) {
+    _deprecated_function( __FUNCTION__, '3.3', 'get_current_screen()->add_help_tab()' );
+
+    if ( is_string( $screen ) )
+        $screen = convert_to_screen( $screen );
+
+    WP_Screen::add_old_compat_help( $screen, $help );
+}