[wp-trac] [WordPress Trac] #41121: Consistency of the _deprecated_function() calls and related documentation.

[WordPress Trac]

#41121: Consistency of the _deprecated_function() calls and related documentation.
--------------------------+-----------------------------
 Reporter:  jrf           |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:  trunk
 Severity:  normal        |   Keywords:
  Focuses:  docs          |
--------------------------+-----------------------------
 While working on [https://github.com/WordPress-Coding-Standards/WordPress-
 Coding-Standards/pull/979 updating the `WP.DeprecatedFunctions` sniff]
 which is part of the [https://github.com/WordPress-Coding-Standards
 /WordPress-Coding-Standards/ WordPress Coding Standards] project, we've
 come across a number of inconsistencies in the application of the function
 and/or the related documentation.

 @jdgrimes previously already reported this concerning three functions in
 #41094 (has its own patch in that ticket), however since then a lot more
 inconsistencies have been identified.

 In a series of patches which I will add to this ticket I will address
 these:

 === Patch 1: Fix deprecation info in various docblocks

 * Fix incorrect deprecation comment naming the deprecated function as its
 own alternative
 * Fix typo in docblock `@deprecated` tag which meant that deprecation is
 not indicated on the dev ref website
 * Add missing `@deprecated` tags for two functions
 * Add missing alternative in `@deprecated` comment for `wp_get_sites()`

 === Patch 2: Add missing replacement functions to various
 `_deprecated_function()` calls

 * Add missing parentheses to a few deprecated function replacement
 function strings to be consistent with how this is done everywhere else.
 * Add missing alternative for the WP_Customize Widget deprecated methods.
 * Add missing alternative for three deprecated ms functions
 * Add missing alternative for deprecated `wp_cache_reset()` function

 === Patch 3: Add missing `_deprecated_function()` function calls to
 various functions

 * Add missing `_deprecated_function()` call for
 `funky_javascript_callback()`
 * Add missing `_deprecated_function()` call for `_save_post_hook()`.
 * Add missing `_deprecated_function()` call for
 `default_topic_count_text()`.
 * Add missing `_deprecated_function()` call for `screen_meta()`.
 * Add missing `_deprecated_function()` call for two screen icon related
 functions
 * Add missing `_deprecated_function()` call for nine wp_dashboard related
 functions
 * Add missing `_deprecated_function()` call for
 `wp_ajax_wp_fullscreen_save_post()`.
 * Add missing `_deprecated_function()` call for
 `ms_deprecated_blogs_file()`

 === Patch 4: Add missing `_deprecated_function()` calls to various
 deprecated class methods

 * Add `_deprecated_function()` calls to all methods within the deprecated
 WP_User_Search class.
 * Add missing `_deprecated_function()` call for four methods in
 WP_Customize_Image_Control

 === Patch 5: Add missing `_deprecated_function()` calls for four
 deprecated pluggable functions.

 Not all functions complied with what the docblock at the top of the files
 states:
 > Deprecated warnings are also thrown if one of these functions is being
 defined by a plugin.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/41121>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform