WordPress.org

Make WordPress Core


Ignore:
Timestamp:
08/20/2015 09:22:26 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize @deprecated tag formatting and add missing DocBlocks to deprecated functions in wp-admin/includes/deprecated.php.

Opted not to use the multi-function DocBlock syntax in the name of not taking shortcuts in documentation for the sake of brevity.

Props Alphawolf for the initial patch.
See #28806

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/deprecated.php

    r32990 r33671  
    1515/**
    1616 * @since 2.1.0
    17  * @deprecated 2.1.0
    18  * @deprecated Use wp_editor().
     17 * @deprecated 2.1.0 Use wp_editor()
    1918 * @see wp_editor()
    2019 */
     
    4039 *
    4140 * @since 2.0.0
    42  * @deprecated 3.0.0
    43  * @deprecated Use wp_constrain_dimensions()
     41 * @deprecated 3.0.0 Use wp_constrain_dimensions()
    4442 * @see wp_constrain_dimensions()
    4543 *
     
    5957 *
    6058 * @since 2.0.0
    61  * @deprecated 3.5.0
    62  * @deprecated Use wp_constrain_dimensions()
     59 * @deprecated 3.5.0 Use wp_constrain_dimensions()
    6360 * @see wp_constrain_dimensions()
    6461 *
     
    7673 *
    7774 * @since 0.71
    78  * @deprecated 2.6.0
    79  * @deprecated Use wp_category_checklist()
     75 * @deprecated 2.6.0 Use wp_category_checklist()
    8076 * @see wp_category_checklist()
    8177 *
     
    9490 *
    9591 * @since 2.1.0
    96  * @deprecated 2.6.0
    97  * @deprecated Use wp_link_category_checklist()
     92 * @deprecated 2.6.0 Use wp_link_category_checklist()
    9893 * @see wp_link_category_checklist()
    9994 *
     
    126121 *
    127122 * @since 1.2.0
    128  * @deprecated 3.0.0
    129  * @deprecated Use wp_dropdown_categories()
     123 * @deprecated 3.0.0 Use wp_dropdown_categories()
    130124 * @see wp_dropdown_categories()
    131125 *
     
    163157 *
    164158 * @since 2.7.0
    165  * @deprecated 3.0.0
    166  * @deprecated Use register_setting()
     159 * @deprecated 3.0.0 Use register_setting()
    167160 * @see register_setting()
    168161 *
     
    181174 *
    182175 * @since 2.7.0
    183  * @deprecated 3.0.0
    184  * @deprecated Use unregister_setting()
     176 * @deprecated 3.0.0 Use unregister_setting()
    185177 * @see unregister_setting()
    186178 *
     
    227219
    228220/**
    229  * @deprecated 3.1.0
     221 * Get all user IDs.
     222 *
     223 * @deprecated 3.1.0 Use get_users()
    230224 *
    231225 * @return array List of user IDs.
     
    244238
    245239/**
    246  * @deprecated 3.1.0
     240 * Gets author users who can edit posts.
     241 *
     242 * @deprecated 3.1.0 Use get_users()
    247243 *
    248244 * @param int $user_id User ID.
     
    267263
    268264/**
    269  * @deprecated 3.1.0
     265 * Gets the IDs of any users who can edit posts.
     266 *
     267 * @deprecated 3.1.0 Use get_users()
    270268 *
    271269 * @param int $user_id User ID.
     
    302300
    303301/**
    304  * @deprecated 3.1.0
     302 * Gets all users who are not authors.
     303 *
     304 * @deprecated 3.1.0 Use get_users()
    305305 */
    306306function get_nonauthor_user_ids() {
     
    322322 *
    323323 * @since 2.1.0
    324  * @deprecated 3.1.0
     324 * @deprecated 3.1.0 Use WP_User_Query
    325325 */
    326326class WP_User_Search {
     
    671671 * Retrieve editable posts from other users.
    672672 *
    673  * @deprecated 3.1.0
     673 * @deprecated 3.1.0 Use get_posts()
     674 * @see get_posts()
    674675 *
    675676 * @param int $user_id User ID to not retrieve posts from.
     
    704705 * Retrieve drafts from other users.
    705706 *
    706  * @deprecated 3.1.0
     707 * @deprecated 3.1.0 Use get_posts()
     708 * @see get_posts()
    707709 *
    708710 * @param int $user_id User ID.
     
    718720 * Retrieve pending review posts from other users.
    719721 *
    720  * @deprecated 3.1.0
     722 * @deprecated 3.1.0 Use get_posts()
     723 * @see get_posts()
    721724 *
    722725 * @param int $user_id User ID.
     
    733736 *
    734737 * @since 3.0.0
    735  * @deprecated 3.2.0
    736  * @deprecated Use wp_dashboard_quick_press()
     738 * @deprecated 3.2.0 Use wp_dashboard_quick_press()
    737739 * @see wp_dashboard_quick_press()
    738740 */
     
    743745
    744746/**
     747 * Outputs the TinyMCE editor.
     748 *
    745749 * @since 2.7.0
    746  * @deprecated 3.3.0
    747  * @deprecated Use wp_editor()
     750 * @deprecated 3.3.0 Use wp_editor()
    748751 * @see wp_editor()
    749752 *
     
    771774
    772775/**
    773  * @deprecated 3.3.0
    774  * @deprecated Use wp_editor()
     776 * Preloads TinyMCE dialogs.
     777 *
     778 * @deprecated 3.3.0 Use wp_editor()
    775779 * @see wp_editor()
    776780 */
     
    780784
    781785/**
    782  * @deprecated 3.3.0
    783  * @deprecated Use wp_editor()
     786 * Prints TinyMCE editor JS.
     787 *
     788 * @deprecated 3.3.0 Use wp_editor()
    784789 * @see wp_editor()
    785790 */
     
    789794
    790795/**
    791  * @deprecated 3.3.0
    792  * @deprecated Use wp_editor()
     796 * Handles quicktags.
     797 *
     798 * @deprecated 3.3.0 Use wp_editor()
    793799 * @see wp_editor()
    794800 */
     
    801807 *
    802808 * @since 2.8.0
    803  * @deprecated 3.3.0
    804  * @deprecated Use $current_screen->render_screen_layout()
     809 * @deprecated 3.3.0 WP_Screen::render_screen_layout()
    805810 * @see WP_Screen::render_screen_layout()
    806811 */
     
    822827 *
    823828 * @since 2.8.0
    824  * @deprecated 3.3.0
    825  * @deprecated Use $current_screen->render_per_page_options()
     829 * @deprecated 3.3.0 Use WP_Screen::render_per_page_options()
    826830 * @see WP_Screen::render_per_page_options()
    827831 */
     
    843847 *
    844848 * @since 2.7.0
    845  * @deprecated 3.3.0
    846  * @deprecated Use $current_screen->render_screen_meta()
     849 * @deprecated 3.3.0 Use WP_Screen::render_screen_meta()
    847850 * @see WP_Screen::render_screen_meta()
    848851 */
     
    856859 *
    857860 * @since 2.7.0
    858  * @deprecated 3.2.0
     861 * @deprecated 3.2.0 Use WP_Admin_Bar
     862 * @see WP_Admin_Bar
    859863 */
    860864function favorite_actions() {
     
    862866}
    863867
     868/**
     869 * Handles uploading an image.
     870 *
     871 * @deprecated 3.3.0 Use wp_media_upload_handler()
     872 * @see wp_media_upload_handler()
     873 *
     874 * @return null|string
     875 */
    864876function media_upload_image() {
    865877    _deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
     
    867879}
    868880
     881/**
     882 * Handles uploading an audio file.
     883 *
     884 * @deprecated 3.3.0 Use wp_media_upload_handler()
     885 * @see wp_media_upload_handler()
     886 *
     887 * @return null|string
     888 */
    869889function media_upload_audio() {
    870890    _deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
     
    872892}
    873893
     894/**
     895 * Handles uploading a video file.
     896 *
     897 * @deprecated 3.3.0 Use wp_media_upload_handler()
     898 * @see wp_media_upload_handler()
     899 *
     900 * @return null|string
     901 */
    874902function media_upload_video() {
    875903    _deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
     
    877905}
    878906
     907/**
     908 * Handles uploading a generic file.
     909 *
     910 * @deprecated 3.3.0 Use wp_media_upload_handler()
     911 * @see wp_media_upload_handler()
     912 *
     913 * @return null|string
     914 */
    879915function media_upload_file() {
    880916    _deprecated_function( __FUNCTION__, '3.3', 'wp_media_upload_handler()' );
     
    882918}
    883919
     920/**
     921 * Handles retrieving the insert-from-URL form for an image.
     922 *
     923 * @deprecated 3.3.0 Use wp_media_insert_url_form()
     924 * @see wp_media_insert_url_form()
     925 *
     926 * @return string
     927 */
    884928function type_url_form_image() {
    885929    _deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('image')" );
     
    887931}
    888932
     933/**
     934 * Handles retrieving the insert-from-URL form for an audio file.
     935 *
     936 * @deprecated 3.3.0 Use wp_media_insert_url_form()
     937 * @see wp_media_insert_url_form()
     938 *
     939 * @return string
     940 */
    889941function type_url_form_audio() {
    890942    _deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('audio')" );
     
    892944}
    893945
     946/**
     947 * Handles retrieving the insert-from-URL form for a video file.
     948 *
     949 * @deprecated 3.3.0 Use wp_media_insert_url_form()
     950 * @see wp_media_insert_url_form()
     951 *
     952 * @return string
     953 */
    894954function type_url_form_video() {
    895955    _deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('video')" );
     
    897957}
    898958
     959/**
     960 * Handles retrieving the insert-from-URL form for a generic file.
     961 *
     962 * @deprecated 3.3.0 Use wp_media_insert_url_form()
     963 * @see wp_media_insert_url_form()
     964 *
     965 * @return string
     966 */
    899967function type_url_form_file() {
    900968    _deprecated_function( __FUNCTION__, '3.3', "wp_media_insert_url_form('file')" );
     
    908976 *
    909977 * @since 2.7.0
    910  * @deprecated 3.3.0
    911  * @deprecated Use get_current_screen()->add_help_tab()
    912  * @see WP_Screen
     978 * @deprecated 3.3.0 Use WP_Screen::add_help_tab()
     979 * @see WP_Screen::add_help_tab()
    913980 *
    914981 * @param string    $screen The handle for the screen to add help to. This is usually the hook name returned by the add_*_page() functions.
     
    928995 *
    929996 * @since 3.0.0
    930  * @deprecated 3.4.0
    931  * @deprecated Use wp_get_themes()
     997 * @deprecated 3.4.0 Use wp_get_themes()
    932998 * @see wp_get_themes()
    933999 *
     
    9481014
    9491015/**
    950  * {@internal Missing Short Description}}
     1016 * Retrieves a list of broken themes.
    9511017 *
    9521018 * @since 1.5.0
    953  * @deprecated 3.4.0
     1019 * @deprecated 3.4.0 Use wp_get_themes()
     1020 * @see wp_get_themes()
    9541021 *
    9551022 * @return array
     
    9721039
    9731040/**
    974  * {@internal Missing Short Description}}
     1041 * Retrieves information on the current active theme.
    9751042 *
    9761043 * @since 2.0.0
    977  * @deprecated 3.4.0
     1044 * @deprecated 3.4.0 Use wp_get_theme()
     1045 * @see wp_get_theme()
    9781046 *
    9791047 * @return WP_Theme
     
    9861054
    9871055/**
    988  * This was once used to display an 'Insert into Post' button. Now it is deprecated and stubbed.
     1056 * This was once used to display an 'Insert into Post' button.
     1057 *
     1058 * Now it is deprecated and stubbed.
    9891059 *
    9901060 * @deprecated 3.5.0
     
    9951065
    9961066/**
    997  * This was once used to display a media button. Now it is deprecated and stubbed.
     1067 * This was once used to display a media button.
     1068 *
     1069 * Now it is deprecated and stubbed.
    9981070 *
    9991071 * @deprecated 3.5.0
     
    10041076
    10051077/**
    1006  * Get an existing post and format it for editing.
     1078 * Gets an existing post and format it for editing.
    10071079 *
    10081080 * @since 2.0.0
    1009  * @deprecated 3.5.0
     1081 * @deprecated 3.5.0 Use get_post()
     1082 * @see get_post()
    10101083 *
    10111084 * @param int $id
     
    10191092
    10201093/**
    1021  * Get the default page information to use.
     1094 * Gets the default page information to use.
    10221095 *
    10231096 * @since 2.5.0
    1024  * @deprecated 3.5.0
    1025  * @deprecated Use get_default_post_to_edit()
     1097 * @deprecated 3.5.0 Use get_default_post_to_edit()
     1098 * @see get_default_post_to_edit()
    10261099 *
    10271100 * @return WP_Post Post object containing all the default post data as attributes
     
    10391112 *
    10401113 * @since 1.2.0
    1041  * @deprecated 3.5.0
    1042  * @deprecated Use image_resize()
     1114 * @deprecated 3.5.0 Use image_resize()
    10431115 * @see image_resize()
    10441116 *
     
    10721144 *
    10731145 * @since 2.7.0
    1074  * @deprecated 3.7.0
     1146 * @deprecated 3.7.0 Use Core_Upgrader
    10751147 * @see Core_Upgrader
    10761148 */
     
    10951167 *
    10961168 * @since 2.5.0
    1097  * @deprecated 3.7.0
     1169 * @deprecated 3.7.0 Use Plugin_Upgrader
    10981170 * @see Plugin_Upgrader
    10991171 */
     
    11171189 *
    11181190 * @since 2.7.0
    1119  * @deprecated 3.7.0
     1191 * @deprecated 3.7.0 Use Theme_Upgrader
    11201192 * @see Theme_Upgrader
    11211193 */
     
    11341206 * This was once used to display attachment links. Now it is deprecated and stubbed.
    11351207 *
    1136  * {@internal Missing Short Description}}
    1137  *
    11381208 * @since 2.0.0
    11391209 * @deprecated 3.7.0
     
    11451215}
    11461216
    1147 /**#@+
     1217/**
    11481218 * Displays a screen icon.
    11491219 *
    11501220 * @since 2.7.0
    11511221 * @since 3.8.0 Screen icons are no longer used in WordPress. This function no longer produces output.
    1152  * @deprecated 3.8.0
     1222 * @deprecated 3.8.0 Use get_screen_icon()
     1223 * @see get_screen_icon()
    11531224 */
    11541225function screen_icon() {
    11551226    echo get_screen_icon();
    11561227}
     1228
     1229/**
     1230 * Retrieves the screen icon (no longer used in 3.8+).
     1231 *
     1232 * @deprecated 3.8.0
     1233 *
     1234 * @return string
     1235 */
    11571236function get_screen_icon() {
    11581237    return '<!-- Screen icons are no longer used as of WordPress 3.8. -->';
    11591238}
    1160 /**#@-*/
    1161 
    1162 /**#@+
     1239
     1240/**
    11631241 * Deprecated dashboard widget controls.
    11641242 *
     
    11671245 */
    11681246function wp_dashboard_incoming_links_output() {}
     1247
     1248/**
     1249 * Deprecated dashboard secondary output.
     1250 *
     1251 * @deprecated 3.8.0
     1252 */
    11691253function wp_dashboard_secondary_output() {}
    1170 /**#@-*/
    1171 
    1172 /**#@+
     1254
     1255/**
    11731256 * Deprecated dashboard widget controls.
    11741257 *
     
    11771260 */
    11781261function wp_dashboard_incoming_links() {}
     1262
     1263/**
     1264 * Deprecated dashboard incoming links control.
     1265 *
     1266 * @deprecated 3.8.0
     1267 */
    11791268function wp_dashboard_incoming_links_control() {}
     1269
     1270/**
     1271 * Deprecated dashboard plugins control.
     1272 *
     1273 * @deprecated 3.8.0
     1274 */
    11801275function wp_dashboard_plugins() {}
     1276
     1277/**
     1278 * Deprecated dashboard primary control.
     1279 *
     1280 * @deprecated 3.8.0
     1281 */
    11811282function wp_dashboard_primary_control() {}
     1283
     1284/**
     1285 * Deprecated dashboard recent comments control.
     1286 *
     1287 * @deprecated 3.8.0
     1288 */
    11821289function wp_dashboard_recent_comments_control() {}
     1290
     1291/**
     1292 * Deprecated dashboard secondary section.
     1293 *
     1294 * @deprecated 3.8.0
     1295 */
    11831296function wp_dashboard_secondary() {}
     1297
     1298/**
     1299 * Deprecated dashboard secondary control.
     1300 *
     1301 * @deprecated 3.8.0
     1302 */
    11841303function wp_dashboard_secondary_control() {}
    1185 /**#@-*/
    11861304
    11871305/**
Note: See TracChangeset for help on using the changeset viewer.