Coding Standards: Consistently use `do_action_deprecated()` and `apply_filters_deprecated()` for deprecated hooks.

Props jrf.
See #48255.
Built from https://develop.svn.wordpress.org/trunk@46684


git-svn-id: http://core.svn.wordpress.org/trunk@46484 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2019-11-09 12:59:03 +00:00
parent 5c094564a7
commit f60094679f
15 changed files with 58 additions and 38 deletions

View File

@ -21,7 +21,7 @@ if ( 'category' == $taxonomy ) {
* *
* @param WP_Term $tag Current category term object. * @param WP_Term $tag Current category term object.
*/ */
do_action( 'edit_category_form_pre', $tag ); do_action_deprecated( 'edit_category_form_pre', array( $tag ), '3.0.0', '{$taxonomy}_pre_edit_form' );
} elseif ( 'link_category' == $taxonomy ) { } elseif ( 'link_category' == $taxonomy ) {
/** /**
* Fires before the Edit Link Category form. * Fires before the Edit Link Category form.
@ -31,7 +31,7 @@ if ( 'category' == $taxonomy ) {
* *
* @param WP_Term $tag Current link category term object. * @param WP_Term $tag Current link category term object.
*/ */
do_action( 'edit_link_category_form_pre', $tag ); do_action_deprecated( 'edit_link_category_form_pre', array( $tag ), '3.0.0', '{$taxonomy}_pre_edit_form' );
} else { } else {
/** /**
* Fires before the Edit Tag form. * Fires before the Edit Tag form.
@ -41,7 +41,7 @@ if ( 'category' == $taxonomy ) {
* *
* @param WP_Term $tag Current tag term object. * @param WP_Term $tag Current tag term object.
*/ */
do_action( 'edit_tag_form_pre', $tag ); do_action_deprecated( 'edit_tag_form_pre', array( $tag ), '3.0.0', '{$taxonomy}_pre_edit_form' );
} }
/** /**
@ -201,7 +201,7 @@ if ( isset( $tag->name ) ) {
* *
* @param WP_Term $tag Current category term object. * @param WP_Term $tag Current category term object.
*/ */
do_action( 'edit_category_form_fields', $tag ); do_action_deprecated( 'edit_category_form_fields', array( $tag ), '3.0.0', '{$taxonomy}_edit_form_fields' );
} elseif ( 'link_category' == $taxonomy ) { } elseif ( 'link_category' == $taxonomy ) {
/** /**
* Fires after the Edit Link Category form fields are displayed. * Fires after the Edit Link Category form fields are displayed.
@ -211,7 +211,7 @@ if ( isset( $tag->name ) ) {
* *
* @param WP_Term $tag Current link category term object. * @param WP_Term $tag Current link category term object.
*/ */
do_action( 'edit_link_category_form_fields', $tag ); do_action_deprecated( 'edit_link_category_form_fields', array( $tag ), '3.0.0', '{$taxonomy}_edit_form_fields' );
} else { } else {
/** /**
* Fires after the Edit Tag form fields are displayed. * Fires after the Edit Tag form fields are displayed.
@ -221,7 +221,7 @@ if ( isset( $tag->name ) ) {
* *
* @param WP_Term $tag Current tag term object. * @param WP_Term $tag Current tag term object.
*/ */
do_action( 'edit_tag_form_fields', $tag ); do_action_deprecated( 'edit_tag_form_fields', array( $tag ), '3.0.0', '{$taxonomy}_edit_form_fields' );
} }
/** /**
* Fires after the Edit Term form fields are displayed. * Fires after the Edit Term form fields are displayed.
@ -241,10 +241,10 @@ if ( isset( $tag->name ) ) {
// Back compat hooks // Back compat hooks
if ( 'category' == $taxonomy ) { if ( 'category' == $taxonomy ) {
/** This action is documented in wp-admin/edit-tags.php */ /** This action is documented in wp-admin/edit-tags.php */
do_action( 'edit_category_form', $tag ); do_action_deprecated( 'edit_category_form', array( $tag ), '3.0.0', '{$taxonomy}_add_form' );
} elseif ( 'link_category' == $taxonomy ) { } elseif ( 'link_category' == $taxonomy ) {
/** This action is documented in wp-admin/edit-tags.php */ /** This action is documented in wp-admin/edit-tags.php */
do_action( 'edit_link_category_form', $tag ); do_action_deprecated( 'edit_link_category_form', array( $tag ), '3.0.0', '{$taxonomy}_add_form' );
} else { } else {
/** /**
* Fires at the end of the Edit Term form. * Fires at the end of the Edit Term form.
@ -254,7 +254,7 @@ if ( 'category' == $taxonomy ) {
* *
* @param WP_Term $tag Current taxonomy term object. * @param WP_Term $tag Current taxonomy term object.
*/ */
do_action( 'edit_tag_form', $tag ); do_action_deprecated( 'edit_tag_form', array( $tag ), '3.0.0', '{$taxonomy}_edit_form' );
} }
/** /**
* Fires at the end of the Edit Term form for all taxonomies. * Fires at the end of the Edit Term form for all taxonomies.

View File

@ -378,7 +378,7 @@ if ( $can_edit_terms ) {
* *
* @param object $arg Optional arguments cast to an object. * @param object $arg Optional arguments cast to an object.
*/ */
do_action( 'add_category_form_pre', (object) array( 'parent' => 0 ) ); do_action_deprecated( 'add_category_form_pre', array( (object) array( 'parent' => 0 ) ), '3.0.0', '{$taxonomy}_pre_add_form' );
} elseif ( 'link_category' == $taxonomy ) { } elseif ( 'link_category' == $taxonomy ) {
/** /**
* Fires before the link category form. * Fires before the link category form.
@ -388,7 +388,7 @@ if ( $can_edit_terms ) {
* *
* @param object $arg Optional arguments cast to an object. * @param object $arg Optional arguments cast to an object.
*/ */
do_action( 'add_link_category_form_pre', (object) array( 'parent' => 0 ) ); do_action_deprecated( 'add_link_category_form_pre', array( (object) array( 'parent' => 0 ) ), '3.0.0', '{$taxonomy}_pre_add_form' );
} else { } else {
/** /**
* Fires before the Add Tag form. * Fires before the Add Tag form.
@ -398,7 +398,7 @@ if ( $can_edit_terms ) {
* *
* @param string $taxonomy The taxonomy slug. * @param string $taxonomy The taxonomy slug.
*/ */
do_action( 'add_tag_form_pre', $taxonomy ); do_action_deprecated( 'add_tag_form_pre', array( $taxonomy ), '3.0.0', '{$taxonomy}_pre_add_form' );
} }
/** /**
@ -534,7 +534,7 @@ if ( $can_edit_terms ) {
* *
* @param object $arg Optional arguments cast to an object. * @param object $arg Optional arguments cast to an object.
*/ */
do_action( 'edit_category_form', (object) array( 'parent' => 0 ) ); do_action_deprecated( 'edit_category_form', array( (object) array( 'parent' => 0 ) ), '3.0.0', '{$taxonomy}_add_form' );
} elseif ( 'link_category' == $taxonomy ) { } elseif ( 'link_category' == $taxonomy ) {
/** /**
* Fires at the end of the Edit Link form. * Fires at the end of the Edit Link form.
@ -544,7 +544,7 @@ if ( $can_edit_terms ) {
* *
* @param object $arg Optional arguments cast to an object. * @param object $arg Optional arguments cast to an object.
*/ */
do_action( 'edit_link_category_form', (object) array( 'parent' => 0 ) ); do_action_deprecated( 'edit_link_category_form', array( (object) array( 'parent' => 0 ) ), '3.0.0', '{$taxonomy}_add_form' );
} else { } else {
/** /**
* Fires at the end of the Add Tag form. * Fires at the end of the Add Tag form.
@ -554,7 +554,7 @@ if ( $can_edit_terms ) {
* *
* @param string $taxonomy The taxonomy slug. * @param string $taxonomy The taxonomy slug.
*/ */
do_action( 'add_tag_form', $taxonomy ); do_action_deprecated( 'add_tag_form', array( $taxonomy ), '3.0.0', '{$taxonomy}_add_form' );
} }
/** /**

View File

@ -796,7 +796,12 @@ final class WP_Screen {
* @param array $old_compat_help Old contextual help. * @param array $old_compat_help Old contextual help.
* @param WP_Screen $this Current WP_Screen instance. * @param WP_Screen $this Current WP_Screen instance.
*/ */
self::$_old_compat_help = apply_filters( 'contextual_help_list', self::$_old_compat_help, $this ); self::$_old_compat_help = apply_filters_deprecated(
'contextual_help_list',
array( self::$_old_compat_help, $this ),
'3.3.0',
'get_current_screen()->add_help_tab(), get_current_screen()->remove_help_tab()'
);
$old_help = isset( self::$_old_compat_help[ $this->id ] ) ? self::$_old_compat_help[ $this->id ] : ''; $old_help = isset( self::$_old_compat_help[ $this->id ] ) ? self::$_old_compat_help[ $this->id ] : '';
@ -811,7 +816,12 @@ final class WP_Screen {
* @param string $screen_id Screen ID. * @param string $screen_id Screen ID.
* @param WP_Screen $this Current WP_Screen instance. * @param WP_Screen $this Current WP_Screen instance.
*/ */
$old_help = apply_filters( 'contextual_help', $old_help, $this->id, $this ); $old_help = apply_filters_deprecated(
'contextual_help',
array( $old_help, $this->id, $this ),
'3.3.0',
'get_current_screen()->add_help_tab(), get_current_screen()->remove_help_tab()'
);
// Default help only if there is no old-style block of text and no new-style help tabs. // Default help only if there is no old-style block of text and no new-style help tabs.
if ( empty( $old_help ) && ! $this->get_help_tabs() ) { if ( empty( $old_help ) && ! $this->get_help_tabs() ) {
@ -825,7 +835,12 @@ final class WP_Screen {
* *
* @param string $old_help_default Default contextual help text. * @param string $old_help_default Default contextual help text.
*/ */
$default_help = apply_filters( 'default_contextual_help', '' ); $default_help = apply_filters_deprecated(
'default_contextual_help',
array( '' ),
'3.3.0',
'get_current_screen()->add_help_tab(), get_current_screen()->remove_help_tab()'
);
if ( $default_help ) { if ( $default_help ) {
$old_help = '<p>' . $default_help . '</p>'; $old_help = '<p>' . $default_help . '</p>';
} }

View File

@ -97,7 +97,7 @@ class WP_Terms_List_Table extends WP_List_Table {
* *
* @param int $tags_per_page Number of tags to be displayed. Default 20. * @param int $tags_per_page Number of tags to be displayed. Default 20.
*/ */
$tags_per_page = apply_filters( 'tagsperpage', $tags_per_page ); $tags_per_page = apply_filters_deprecated( 'tagsperpage', array( $tags_per_page ), '2.8.0', 'edit_tags_per_page' );
} elseif ( 'category' === $this->screen->taxonomy ) { } elseif ( 'category' === $this->screen->taxonomy ) {
/** /**
* Filters the number of terms displayed per page for the Categories list table. * Filters the number of terms displayed per page for the Categories list table.
@ -508,7 +508,7 @@ class WP_Terms_List_Table extends WP_List_Table {
* 'Edit', 'Quick Edit', 'Delete', and 'View'. * 'Edit', 'Quick Edit', 'Delete', and 'View'.
* @param WP_Term $tag Term object. * @param WP_Term $tag Term object.
*/ */
$actions = apply_filters( 'tag_row_actions', $actions, $tag ); $actions = apply_filters_deprecated( 'tag_row_actions', array( $actions, $tag ), '3.0.0', '{$taxonomy}_row_actions' );
/** /**
* Filters the action links displayed for each term in the terms list table. * Filters the action links displayed for each term in the terms list table.

View File

@ -292,7 +292,7 @@ function wp_stream_image( $image, $mime_type, $attachment_id ) {
* @param resource $image Image resource to be streamed. * @param resource $image Image resource to be streamed.
* @param int $attachment_id The attachment post ID. * @param int $attachment_id The attachment post ID.
*/ */
$image = apply_filters( 'image_save_pre', $image, $attachment_id ); $image = apply_filters_deprecated( 'image_save_pre', array( $image, $attachment_id ), '3.5.0', 'image_editor_save_pre' );
switch ( $mime_type ) { switch ( $mime_type ) {
case 'image/jpeg': case 'image/jpeg':
@ -353,7 +353,7 @@ function wp_save_image_file( $filename, $image, $mime_type, $post_id ) {
_deprecated_argument( __FUNCTION__, '3.5.0', sprintf( __( '%1$s needs to be a %2$s object.' ), '$image', 'WP_Image_Editor' ) ); _deprecated_argument( __FUNCTION__, '3.5.0', sprintf( __( '%1$s needs to be a %2$s object.' ), '$image', 'WP_Image_Editor' ) );
/** This filter is documented in wp-admin/includes/image-edit.php */ /** This filter is documented in wp-admin/includes/image-edit.php */
$image = apply_filters( 'image_save_pre', $image, $post_id ); $image = apply_filters_deprecated( 'image_save_pre', array( $image, $post_id ), '3.5.0', 'image_editor_save_pre' );;
/** /**
* Filters whether to skip saving the image file. * Filters whether to skip saving the image file.
@ -370,7 +370,7 @@ function wp_save_image_file( $filename, $image, $mime_type, $post_id ) {
* @param string $mime_type Image mime type. * @param string $mime_type Image mime type.
* @param int $post_id Post ID. * @param int $post_id Post ID.
*/ */
$saved = apply_filters( 'wp_save_image_file', null, $filename, $image, $mime_type, $post_id ); $saved = apply_filters_deprecated( 'wp_save_image_file', array( null, $filename, $image, $mime_type, $post_id ), '3.5.0', 'wp_save_image_editor_file' );
if ( null !== $saved ) { if ( null !== $saved ) {
return $saved; return $saved;
@ -570,7 +570,7 @@ function image_edit_apply_changes( $image, $changes ) {
* @param resource $image GD image resource. * @param resource $image GD image resource.
* @param array $changes Array of change operations. * @param array $changes Array of change operations.
*/ */
$image = apply_filters( 'image_edit_before_change', $image, $changes ); $image = apply_filters_deprecated( 'image_edit_before_change', array( $image, $changes ), '3.5.0', 'wp_image_editor_before_change' );
} }
foreach ( $changes as $operation ) { foreach ( $changes as $operation ) {

View File

@ -654,7 +654,7 @@ function media_buttons( $editor_id = 'content' ) {
* *
* @param string $string Media buttons context. Default empty. * @param string $string Media buttons context. Default empty.
*/ */
$legacy_filter = apply_filters( 'media_buttons_context', '' ); $legacy_filter = apply_filters_deprecated( 'media_buttons_context', array( '' ), '3.5.0', 'media_buttons' );
if ( $legacy_filter ) { if ( $legacy_filter ) {
// #WP22559. Close <a> if a plugin started by closing <a> to open their own <a> tag. // #WP22559. Close <a> if a plugin started by closing <a> to open their own <a> tag.

View File

@ -1508,7 +1508,7 @@ function register_and_do_post_meta_boxes( $post ) {
* *
* @param WP_Post $post Post object. * @param WP_Post $post Post object.
*/ */
do_action( 'dbx_post_advanced', $post ); do_action_deprecated( 'dbx_post_advanced', array( $post ), '3.7.0', 'add_meta_boxes' );
// Allow the Discussion meta box to show up if the post type supports comments, // Allow the Discussion meta box to show up if the post type supports comments,
// or if comments or pings are open. // or if comments or pings are open.

View File

@ -1411,7 +1411,7 @@ class WP_Rewrite {
* *
* @param string[] $rules Array of rewrite rules generated for tags, keyed by their regex pattern. * @param string[] $rules Array of rewrite rules generated for tags, keyed by their regex pattern.
*/ */
$rules = apply_filters( 'tag_rewrite_rules', $rules ); $rules = apply_filters_deprecated( 'tag_rewrite_rules', array( $rules ), '3.1.0', 'post_tag_rewrite_rules' );
} }
$this->extra_rules_top = array_merge( $this->extra_rules_top, $rules ); $this->extra_rules_top = array_merge( $this->extra_rules_top, $rules );
@ -1560,7 +1560,7 @@ class WP_Rewrite {
* *
* @param string $rules mod_rewrite Rewrite rules formatted for .htaccess. * @param string $rules mod_rewrite Rewrite rules formatted for .htaccess.
*/ */
return apply_filters( 'rewrite_rules', $rules ); return apply_filters_deprecated( 'rewrite_rules', array( $rules ), '1.5.0', 'mod_rewrite_rules' );
} }
/** /**

View File

@ -235,9 +235,9 @@ class wp_xmlrpc_server extends IXR_Server {
* Respect old get_option() filters left for back-compat when the 'enable_xmlrpc' * Respect old get_option() filters left for back-compat when the 'enable_xmlrpc'
* option was deprecated in 3.5.0. Use the 'xmlrpc_enabled' hook instead. * option was deprecated in 3.5.0. Use the 'xmlrpc_enabled' hook instead.
*/ */
$enabled = apply_filters( 'pre_option_enable_xmlrpc', false ); $enabled = apply_filters_deprecated( 'pre_option_enable_xmlrpc', array( false ), '3.5.0', 'xmlrpc_enabled' );
if ( false === $enabled ) { if ( false === $enabled ) {
$enabled = apply_filters( 'option_enable_xmlrpc', true ); $enabled = apply_filters_deprecated( 'option_enable_xmlrpc', array( true ), '3.5.0', 'xmlrpc_enabled' );
} }
/** /**

View File

@ -546,7 +546,12 @@ class WP {
* *
* @param string $query_string The query string to modify. * @param string $query_string The query string to modify.
*/ */
$this->query_string = apply_filters( 'query_string', $this->query_string ); $this->query_string = apply_filters_deprecated(
'query_string',
array( $this->query_string ),
'2.1.0',
'query_vars, request'
);
parse_str( $this->query_string, $this->query_vars ); parse_str( $this->query_string, $this->query_vars );
} }
} }

View File

@ -6332,7 +6332,7 @@ function get_posts_by_author_sql( $post_type, $full = true, $post_author = null,
* *
* @param string $cap Capability. * @param string $cap Capability.
*/ */
$cap = apply_filters( 'pub_priv_sql_capability', '' ); $cap = apply_filters_deprecated( 'pub_priv_sql_capability', array( '' ), '3.2.0' );
if ( ! $cap ) { if ( ! $cap ) {
$cap = current_user_can( $post_type_obj->cap->read_private_posts ); $cap = current_user_can( $post_type_obj->cap->read_private_posts );
} }
@ -6741,7 +6741,7 @@ function _transition_post_status( $new_status, $old_status, $post ) {
* *
* @param int $post_id Post ID. * @param int $post_id Post ID.
*/ */
do_action( 'private_to_published', $post->ID ); do_action_deprecated( 'private_to_published', array( $post->ID ), '2.3.0', 'private_to_publish' );
} }
// If published posts changed clear the lastpostmodified cache. // If published posts changed clear the lastpostmodified cache.

View File

@ -4249,7 +4249,7 @@ function get_term_link( $term, $taxonomy = '' ) {
* @param string $termlink Tag link URL. * @param string $termlink Tag link URL.
* @param int $term_id Term ID. * @param int $term_id Term ID.
*/ */
$termlink = apply_filters( 'tag_link', $termlink, $term->term_id ); $termlink = apply_filters_deprecated( 'tag_link', array( $termlink, $term->term_id ), '2.5.0', 'term_link' );
} elseif ( 'category' === $taxonomy ) { } elseif ( 'category' === $taxonomy ) {
/** /**
@ -4261,7 +4261,7 @@ function get_term_link( $term, $taxonomy = '' ) {
* @param string $termlink Category link URL. * @param string $termlink Category link URL.
* @param int $term_id Term ID. * @param int $term_id Term ID.
*/ */
$termlink = apply_filters( 'category_link', $termlink, $term->term_id ); $termlink = apply_filters_deprecated( 'category_link', array( $termlink, $term->term_id ), '2.5.0', 'term_link' );
} }
/** /**

View File

@ -2277,7 +2277,7 @@ function get_password_reset_key( $user ) {
* *
* @param string $user_login The user login name. * @param string $user_login The user login name.
*/ */
do_action( 'retreive_password', $user->user_login ); do_action_deprecated( 'retreive_password', array( $user->user_login ), '1.5.1', 'retrieve_password' );
/** /**
* Fires before a new password is retrieved. * Fires before a new password is retrieved.

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.4-alpha-46683'; $wp_version = '5.4-alpha-46684';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -457,7 +457,7 @@ function validate_another_blog_signup() {
* *
* @param array $blog_meta_defaults An array of default blog meta variables. * @param array $blog_meta_defaults An array of default blog meta variables.
*/ */
$meta_defaults = apply_filters( 'signup_create_blog_meta', $blog_meta_defaults ); $meta_defaults = apply_filters_deprecated( 'signup_create_blog_meta', array( $blog_meta_defaults ), '3.0.0', 'add_signup_meta' );
/** /**
* Filters the new default site meta variables. * Filters the new default site meta variables.