Make WordPress Core

Changeset 46685


Ignore:
Timestamp:
11/09/2019 01:03:02 PM (7 years ago)
Author:
SergeyBiryukov
Message:

Docs: Use the {@see ...} tag for the replacement in @deprecated tags, so that Developer Reference could automatically link to the replacement.

Props jrf.
See #48255.

Location:
trunk/src
Files:
16 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/edit-tag-form.php

    r46684 r46685  
    1818         *
    1919         * @since 2.1.0
    20          * @deprecated 3.0.0 Use {$taxonomy}_pre_edit_form instead.
     20         * @deprecated 3.0.0 Use {@see '{$taxonomy}_pre_edit_form'} instead.
    2121         *
    2222         * @param WP_Term $tag Current category term object.
    … …  
    2828         *
    2929         * @since 2.3.0
    30          * @deprecated 3.0.0 Use {$taxonomy}_pre_edit_form instead.
     30         * @deprecated 3.0.0 Use {@see '{$taxonomy}_pre_edit_form'} instead.
    3131         *
    3232         * @param WP_Term $tag Current link category term object.
    … …  
    3838         *
    3939         * @since 2.5.0
    40          * @deprecated 3.0.0 Use {$taxonomy}_pre_edit_form instead.
     40         * @deprecated 3.0.0 Use {@see '{$taxonomy}_pre_edit_form'} instead.
    4141         *
    4242         * @param WP_Term $tag Current tag term object.
    … …  
    198198                         *
    199199                         * @since 2.9.0
    200                          * @deprecated 3.0.0 Use {$taxonomy}_edit_form_fields instead.
     200                         * @deprecated 3.0.0 Use {@see '{$taxonomy}_edit_form_fields'} instead.
    201201                         *
    202202                         * @param WP_Term $tag Current category term object.
    … …  
    208208                         *
    209209                         * @since 2.9.0
    210                          * @deprecated 3.0.0 Use {$taxonomy}_edit_form_fields instead.
     210                         * @deprecated 3.0.0 Use {@see '{$taxonomy}_edit_form_fields'} instead.
    211211                         *
    212212                         * @param WP_Term $tag Current link category term object.
    … …  
    218218                         *
    219219                         * @since 2.9.0
    220                          * @deprecated 3.0.0 Use {$taxonomy}_edit_form_fields instead.
     220                         * @deprecated 3.0.0 Use {@see '{$taxonomy}_edit_form_fields'} instead.
    221221                         *
    222222                         * @param WP_Term $tag Current tag term object.
    … …  
    251251         *
    252252         * @since 2.5.0
    253          * @deprecated 3.0.0 Use {$taxonomy}_edit_form instead.
     253         * @deprecated 3.0.0 Use {@see '{$taxonomy}_edit_form'} instead.
    254254         *
    255255         * @param WP_Term $tag Current taxonomy term object.
  • trunk/src/wp-admin/edit-tags.php

    r46684 r46685  
    375375                 *
    376376                 * @since 2.1.0
    377                  * @deprecated 3.0.0 Use {$taxonomy}_pre_add_form instead.
     377                 * @deprecated 3.0.0 Use {@see '{$taxonomy}_pre_add_form'} instead.
    378378                 *
    379379                 * @param object $arg Optional arguments cast to an object.
    … …  
    385385                 *
    386386                 * @since 2.3.0
    387                  * @deprecated 3.0.0 Use {$taxonomy}_pre_add_form instead.
     387                 * @deprecated 3.0.0 Use {@see '{$taxonomy}_pre_add_form'} instead.
    388388                 *
    389389                 * @param object $arg Optional arguments cast to an object.
    … …  
    395395                 *
    396396                 * @since 2.5.0
    397                  * @deprecated 3.0.0 Use {$taxonomy}_pre_add_form instead.
     397                 * @deprecated 3.0.0 Use {@see '{$taxonomy}_pre_add_form'} instead.
    398398                 *
    399399                 * @param string $taxonomy The taxonomy slug.
    … …  
    531531                 *
    532532                 * @since 2.1.0
    533                  * @deprecated 3.0.0 Use {$taxonomy}_add_form instead.
     533                 * @deprecated 3.0.0 Use {@see '{$taxonomy}_add_form'} instead.
    534534                 *
    535535                 * @param object $arg Optional arguments cast to an object.
    … …  
    541541                 *
    542542                 * @since 2.3.0
    543                  * @deprecated 3.0.0 Use {$taxonomy}_add_form instead.
     543                 * @deprecated 3.0.0 Use {@see '{$taxonomy}_add_form'} instead.
    544544                 *
    545545                 * @param object $arg Optional arguments cast to an object.
    … …  
    551551                 *
    552552                 * @since 2.7.0
    553                  * @deprecated 3.0.0 Use {$taxonomy}_add_form instead.
     553                 * @deprecated 3.0.0 Use {@see '{$taxonomy}_add_form'} instead.
    554554                 *
    555555                 * @param string $taxonomy The taxonomy slug.
  • trunk/src/wp-admin/includes/class-wp-screen.php

    r46684 r46685  
    791791                 *
    792792                 * @since 2.7.0
    793                  * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or
    794                  *                   get_current_screen()->remove_help_tab() instead.
     793                 * @deprecated 3.3.0 Use {@see get_current_screen()->add_help_tab()} or
     794                 *                   {@see get_current_screen()->remove_help_tab()} instead.
    795795                 *
    796796                 * @param array     $old_compat_help Old contextual help.
    … …  
    810810                 *
    811811                 * @since 2.7.0
    812                  * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or
    813                  *                   get_current_screen()->remove_help_tab() instead.
     812                 * @deprecated 3.3.0 Use {@see get_current_screen()->add_help_tab()} or
     813                 *                   {@see get_current_screen()->remove_help_tab()} instead.
    814814                 *
    815815                 * @param string    $old_help  Help text that appears on the screen.
    … …  
    831831                         *
    832832                         * @since 2.8.0
    833                          * @deprecated 3.3.0 Use get_current_screen()->add_help_tab() or
    834                          *                   get_current_screen()->remove_help_tab() instead.
     833                         * @deprecated 3.3.0 Use {@see get_current_screen()->add_help_tab()} or
     834                         *                   {@see get_current_screen()->remove_help_tab()} instead.
    835835                         *
    836836                         * @param string $old_help_default Default contextual help text.
  • trunk/src/wp-admin/includes/class-wp-terms-list-table.php

    r46684 r46685  
    9494                         *
    9595                         * @since 2.7.0
    96                          * @deprecated 2.8.0 Use edit_tags_per_page instead.
     96                         * @deprecated 2.8.0 Use {@see 'edit_tags_per_page'} instead.
    9797                         *
    9898                         * @param int $tags_per_page Number of tags to be displayed. Default 20.
    … …  
    503503                 *
    504504                 * @since 2.8.0
    505                  * @deprecated 3.0.0 Use {$taxonomy}_row_actions instead.
     505                 * @deprecated 3.0.0 Use {@see '{$taxonomy}_row_actions'} instead.
    506506                 *
    507507                 * @param string[] $actions An array of action links to be displayed. Default
  • trunk/src/wp-admin/includes/image-edit.php

    r46684 r46685  
    288288                 *
    289289                 * @since 2.9.0
    290                  * @deprecated 3.5.0 Use image_editor_save_pre instead.
     290                 * @deprecated 3.5.0 Use {@see 'image_editor_save_pre'} instead.
    291291                 *
    292292                 * @param resource $image         Image resource to be streamed.
    … …  
    363363                 *
    364364                 * @since 2.9.0
    365                  * @deprecated 3.5.0 Use wp_save_image_editor_file instead.
     365                 * @deprecated 3.5.0 Use {@see 'wp_save_image_editor_file'} instead.
    366366                 *
    367367                 * @param mixed           $override  Value to return instead of saving. Default null.
    … …  
    566566                 *
    567567                 * @since 2.9.0
    568                  * @deprecated 3.5.0 Use wp_image_editor_before_change instead.
     568                 * @deprecated 3.5.0 Use {@see 'wp_image_editor_before_change'} instead.
    569569                 *
    570570                 * @param resource $image   GD image resource.
  • trunk/src/wp-admin/includes/meta-boxes.php

    r46684 r46685  
    15051505         *
    15061506         * @since 2.1.0
    1507          * @deprecated 3.7.0 Use 'add_meta_boxes' instead.
     1507         * @deprecated 3.7.0 Use {@see 'add_meta_boxes'} instead.
    15081508         *
    15091509         * @param WP_Post $post Post object.
  • trunk/src/wp-includes/capabilities.php

    r46661 r46685  
    355355                                         *
    356356                                         * @since 4.6.0 As `auth_post_{$post_type}_meta_{$meta_key}`.
    357                                          * @since 4.7.0
    358                                          * @deprecated 4.9.8 Use `auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}`
     357                                         * @since 4.7.0 Renamed from `auth_post_{$post_type}_meta_{$meta_key}` to
     358                                         *              `auth_{$object_type}_{$object_subtype}_meta_{$meta_key}`.
     359                                         * @deprecated 4.9.8 Use {@see 'auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}'} instead.
    359360                                         *
    360361                                         * @param bool     $allowed   Whether the user can add the object meta. Default false.
  • trunk/src/wp-includes/class-wp-rewrite.php

    r46684 r46685  
    14081408                                 *
    14091409                                 * @since 2.3.0
    1410                                  * @deprecated 3.1.0 Use 'post_tag_rewrite_rules' instead
     1410                                 * @deprecated 3.1.0 Use {@see 'post_tag_rewrite_rules'} instead.
    14111411                                 *
    14121412                                 * @param string[] $rules Array of rewrite rules generated for tags, keyed by their regex pattern.
    … …  
    15571557                 *
    15581558                 * @since 1.5.0
    1559                  * @deprecated 1.5.0 Use the mod_rewrite_rules filter instead.
     1559                 * @deprecated 1.5.0 Use the {@see 'mod_rewrite_rules'} filter instead.
    15601560                 *
    15611561                 * @param string $rules mod_rewrite Rewrite rules formatted for .htaccess.
  • trunk/src/wp-includes/class-wp.php

    r46684 r46685  
    543543                         *
    544544                         * @since 1.5.0
    545                          * @deprecated 2.1.0 Use 'query_vars' or 'request' filters instead.
     545                         * @deprecated 2.1.0 Use {@see 'query_vars'} or {@see 'request'} filters instead.
    546546                         *
    547547                         * @param string $query_string The query string to modify.
  • trunk/src/wp-includes/ms-blogs.php

    r46660 r46685  
    250250         *
    251251         * @since MU (3.0.0)
    252          * @deprecated 4.7.0 Use site_details
     252         * @deprecated 4.7.0 Use {@see 'site_details'} instead.
    253253         *
    254254         * @param object $details The blog details.
  • trunk/src/wp-includes/ms-site.php

    r46586 r46685  
    122122                 *
    123123                 * @since MU (3.0.0)
    124                  * @deprecated 5.1.0 Use wp_insert_site
     124                 * @deprecated 5.1.0 Use {@see 'wp_insert_site'} instead.
    125125                 *
    126126                 * @param int    $site_id    Site ID.
    … …  
    10271027         *
    10281028         * @since 3.4.0
    1029          * @deprecated 4.9.0 Use clean_site_cache
     1029         * @deprecated 4.9.0 Use {@see 'clean_site_cache'} instead.
    10301030         *
    10311031         * @param int $blog_id Blog ID.
  • trunk/src/wp-includes/post.php

    r46684 r46685  
    67386738                 *
    67396739                 * @since 1.5.0
    6740                  * @deprecated 2.3.0 Use 'private_to_publish' instead.
     6740                 * @deprecated 2.3.0 Use {@see 'private_to_publish'} instead.
    67416741                 *
    67426742                 * @param int $post_id Post ID.
  • trunk/src/wp-includes/rest-api/class-wp-rest-server.php

    r46660 r46685  
    261261                 *
    262262                 * @since 4.4.0
    263                  * @deprecated 4.7.0 Use the rest_authentication_errors filter to restrict access to the API
     263                 * @deprecated 4.7.0 Use the {@see 'rest_authentication_errors'} filter to
     264                 *                   restrict access to the API.
    264265                 *
    265266                 * @param bool $rest_enabled Whether the REST API is enabled. Default true.
  • trunk/src/wp-includes/taxonomy.php

    r46684 r46685  
    42454245                 *
    42464246                 * @since 2.3.0
    4247                  * @deprecated 2.5.0 Use 'term_link' instead.
     4247                 * @deprecated 2.5.0 Use {@see 'term_link'} instead.
    42484248                 *
    42494249                 * @param string $termlink Tag link URL.
    … …  
    42574257                 *
    42584258                 * @since 1.5.0
    4259                  * @deprecated 2.5.0 Use 'term_link' instead.
     4259                 * @deprecated 2.5.0 Use {@see 'term_link'} instead.
    42604260                 *
    42614261                 * @param string $termlink Category link URL.
  • trunk/src/wp-includes/user.php

    r46684 r46685  
    22742274         *
    22752275         * @since 1.5.0
    2276          * @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead.
     2276         * @deprecated 1.5.1 Misspelled. Use {@see 'retrieve_password'} hook instead.
    22772277         *
    22782278         * @param string $user_login The user login name.
  • trunk/src/wp-login.php

    r46650 r46685  
    142142         *
    143143         * @since 2.1.0
    144          * @deprecated 5.2.0 Use login_headertext
     144         * @deprecated 5.2.0 Use {@see 'login_headertext'} instead.
    145145         *
    146146         * @param string $login_header_title Login header logo title attribute.
Note: See TracChangeset for help on using the changeset viewer.