Changeset 62477

Timestamp:

06/09/2026 03:52:45 AM (3 months ago)

Author:

westonruter

Message:

Docs: Fix broken replacement links in contextual help filter docs.

The @deprecated tags for the legacy contextual_help_list, contextual_help, and default_contextual_help filters pointed to {@see get_current_screen()->add_help_tab()} and {@see get_current_screen()->remove_help_tab()}. These method-call chains are not resolvable references, so they rendered as broken links on the Developer Reference site (and in IDEs such as PhpStorm). Replace them with references that resolve: get_current_screen(), WP_Screen::add_help_tab(), and WP_Screen::remove_help_tab().

Developed in ​https://github.com/WordPress/wordpress-develop/pull/12071.
Follow-up to r46685.

Props ekamran, yusufmudagal, dhruvang21, codesmith32.
Fixes #65401.

File:

• trunk/src/wp-admin/includes/class-wp-screen.php (modified) (3 diffs)

trunk/src/wp-admin/includes/class-wp-screen.php

@@ -793 +793 @@
                  *
                  * @since 2.7.0
-                 * @deprecated 3.3.0 Use {@see get_current_screen()->add_help_tab()} or
-                 *                   {@see get_current_screen()->remove_help_tab()} instead.
+                 * @deprecated 3.3.0 Use {@see get_current_screen()} with
+                 *                   {@see WP_Screen::add_help_tab()} or
+                 *                   {@see WP_Screen::remove_help_tab()} instead.
                  *
                  * @param array     $old_compat_help Old contextual help.
@@ -812 +813 @@
                  *
                  * @since 2.7.0
-                 * @deprecated 3.3.0 Use {@see get_current_screen()->add_help_tab()} or
-                 *                   {@see get_current_screen()->remove_help_tab()} instead.
+                 * @deprecated 3.3.0 Use {@see get_current_screen()} with
+                 *                   {@see WP_Screen::add_help_tab()} or
+                 *                   {@see WP_Screen::remove_help_tab()} instead.
                  *
                  * @param string    $old_help  Help text that appears on the screen.
@@ -833 +835 @@
                          *
                          * @since 2.8.0
-                         * @deprecated 3.3.0 Use {@see get_current_screen()->add_help_tab()} or
-                         *                   {@see get_current_screen()->remove_help_tab()} instead.
+                         * @deprecated 3.3.0 Use {@see get_current_screen()} with
+                         *                   {@see WP_Screen::add_help_tab()} or
+                         *                   {@see WP_Screen::remove_help_tab()} instead.
                          *
                          * @param string $old_help_default Default contextual help text.