Hooks: Standardize naming of dynamic hooks to use interpolation vs concatenation.

DrewAPicture · DrewAPicture · commit b4fca4a558b7 · 2016-08-22T18:24:48.000Z
Benefits gained in discoverability and self-documentation throughout core trump the negligible performance hit in using interpolation in hook names. Props ramiy. See #37748. git-svn-id: https://develop.svn.wordpress.org/trunk@38307 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-admin/admin-footer.php b/src/wp-admin/admin-footer.php
@@ -83,7 +83,7 @@
  *
  * @param string $hook_suffix The current admin page.
  */
-do_action( "admin_print_footer_scripts-$hook_suffix" );
+do_action( "admin_print_footer_scripts-{$hook_suffix}" );
 
 /**
  * Prints any scripts and data queued for the footer.
@@ -103,7 +103,7 @@
  * @global string $hook_suffix
  * @param string $hook_suffix The current admin page.
  */
-do_action( "admin_footer-$hook_suffix" );
+do_action( "admin_footer-{$hook_suffix}" );
 
 // get_site_option() won't exist when auto upgrading from <= 2.7
 if ( function_exists('get_site_option') ) {
diff --git a/src/wp-admin/admin-header.php b/src/wp-admin/admin-header.php
@@ -96,7 +96,7 @@
  *
  * @since 2.6.0
  */
-do_action( "admin_print_styles-$hook_suffix" );
+do_action( "admin_print_styles-{$hook_suffix}" );
 
 /**
  * Fires when styles are printed for all admin pages.
@@ -110,7 +110,7 @@
  *
  * @since 2.1.0
  */
-do_action( "admin_print_scripts-$hook_suffix" );
+do_action( "admin_print_scripts-{$hook_suffix}" );
 
 /**
  * Fires when scripts are printed for all admin pages.
@@ -127,7 +127,7 @@
  *
  * @since 2.1.0
  */
-do_action( "admin_head-$hook_suffix" );
+do_action( "admin_head-{$hook_suffix}" );
 
 /**
  * Fires in head section for all admin pages.
diff --git a/src/wp-admin/admin.php b/src/wp-admin/admin.php
@@ -209,7 +209,7 @@
 		 *
 		 * @since 2.1.0
 		 */
-		do_action( 'load-' . $page_hook );
+		do_action( "load-{$page_hook}" );
 		if (! isset($_GET['noheader']))
 			require_once(ABSPATH . 'wp-admin/admin-header.php');
 
@@ -239,7 +239,7 @@
 		 *
 		 * @since 1.5.0
 		 */
-		do_action( 'load-' . $plugin_page );
+		do_action( "load-{$plugin_page}" );
 
 		if ( !isset($_GET['noheader']))
 			require_once(ABSPATH . 'wp-admin/admin-header.php');
@@ -278,7 +278,7 @@
 	 *
 	 * @since 3.5.0
 	 */
-	do_action( 'load-importer-' . $importer );
+	do_action( "load-importer-{$importer}" );
 
 	$parent_file = 'tools.php';
 	$submenu_file = 'import.php';
@@ -326,7 +326,7 @@
 	 *
 	 * @since 2.1.0
 	 */
-	do_action( 'load-' . $pagenow );
+	do_action( "load-{$pagenow}" );
 
 	/*
 	 * The following hooks are fired to ensure backward compatibility.
diff --git a/src/wp-admin/edit-form-advanced.php b/src/wp-admin/edit-form-advanced.php
@@ -331,7 +331,7 @@
  *
  * @param WP_Post $post Post object.
  */
-do_action( 'add_meta_boxes_' . $post_type, $post );
+do_action( "add_meta_boxes_{$post_type}", $post );
 
 /**
  * Fires after meta boxes have been added.
diff --git a/src/wp-admin/includes/class-wp-automatic-updater.php b/src/wp-admin/includes/class-wp-automatic-updater.php
@@ -176,7 +176,7 @@ public function should_update( $type, $item, $context ) {
 		 * @param bool   $update Whether to update.
 		 * @param object $item   The update offer.
 		 */
-		$update = apply_filters( 'auto_update_' . $type, $update, $item );
+		$update = apply_filters( "auto_update_{$type}", $update, $item );
 
 		if ( ! $update ) {
 			if ( 'core' == $type )
diff --git a/src/wp-admin/includes/class-wp-ms-themes-list-table.php b/src/wp-admin/includes/class-wp-ms-themes-list-table.php
@@ -518,7 +518,7 @@ public function column_name( $theme ) {
 		 * @param WP_Theme $theme   The current WP_Theme object.
 		 * @param string   $context Status of the theme.
 		 */
-		$actions = apply_filters( "theme_action_links_$stylesheet", $actions, $theme, $context );
+		$actions = apply_filters( "theme_action_links_{$stylesheet}", $actions, $theme, $context );
 
 		echo $this->row_actions( $actions, true );
 	}
@@ -726,6 +726,6 @@ public function single_row( $theme ) {
 		 * @param WP_Theme $theme      Current WP_Theme object.
 		 * @param string   $status     Status of the theme.
 		 */
-		do_action( "after_theme_row_$stylesheet", $stylesheet, $theme, $status );
+		do_action( "after_theme_row_{$stylesheet}", $stylesheet, $theme, $status );
 	}
 }
diff --git a/src/wp-admin/includes/class-wp-plugin-install-list-table.php b/src/wp-admin/includes/class-wp-plugin-install-list-table.php
@@ -200,7 +200,7 @@ public function prepare_items() {
 		 *
 		 * @param array|bool $args Plugin Install API arguments.
 		 */
-		$args = apply_filters( "install_plugins_table_api_args_$tab", $args );
+		$args = apply_filters( "install_plugins_table_api_args_{$tab}", $args );
 
 		if ( !$args )
 			return;
diff --git a/src/wp-admin/includes/class-wp-plugins-list-table.php b/src/wp-admin/includes/class-wp-plugins-list-table.php
@@ -864,7 +864,7 @@ public function single_row( $item ) {
 		 *                            'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
 		 *                            'Drop-ins', 'Search'.
 		 */
-		do_action( "after_plugin_row_$plugin_file", $plugin_file, $plugin_data, $status );
+		do_action( "after_plugin_row_{$plugin_file}", $plugin_file, $plugin_data, $status );
 	}
 
 	/**
diff --git a/src/wp-admin/includes/class-wp-theme-install-list-table.php b/src/wp-admin/includes/class-wp-theme-install-list-table.php
@@ -134,7 +134,7 @@ public function prepare_items() {
 		 *
 		 * @param array $args An array of themes API arguments.
 		 */
-		$args = apply_filters( 'install_themes_table_api_args_' . $tab, $args );
+		$args = apply_filters( "install_themes_table_api_args_{$tab}", $args );
 
 		if ( ! $args )
 			return;
diff --git a/src/wp-admin/includes/media.php b/src/wp-admin/includes/media.php
@@ -618,7 +618,7 @@ function get_upload_iframe_src( $type = null, $post_id = null, $tab = null ) {
 	 *
 	 * @param string $upload_iframe_src The upload iframe source URL by type.
 	 */
-	$upload_iframe_src = apply_filters( $type . '_upload_iframe_src', $upload_iframe_src );
+	$upload_iframe_src = apply_filters( "{$type}_upload_iframe_src", $upload_iframe_src );
 
 	return add_query_arg('TB_iframe', true, $upload_iframe_src);
 }
@@ -786,7 +786,7 @@ function wp_media_upload_handler() {
 			 * @param string $src   Media source URL.
 			 * @param string $title Media title.
 			 */
-			$html = apply_filters( $type . '_send_to_editor_url', $html, esc_url_raw( $src ), $title );
+			$html = apply_filters( "{$type}_send_to_editor_url", $html, esc_url_raw( $src ), $title );
 		} else {
 			$align = '';
 			$alt = esc_attr( wp_unslash( $_POST['alt'] ) );
diff --git a/src/wp-admin/includes/plugin.php b/src/wp-admin/includes/plugin.php
@@ -588,7 +588,7 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
 			 * @param bool $network_wide Whether to enable the plugin for all sites in the network
 			 *                           or just the current site. Multisite only. Default is false.
 			 */
-			do_action( 'activate_' . $plugin, $network_wide );
+			do_action( "activate_{$plugin}", $network_wide );
 		}
 
 		if ( $network_wide ) {
@@ -701,7 +701,7 @@ function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
 			 * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
 			 *                                   or just the current site. Multisite only. Default is false.
 			 */
-			do_action( 'deactivate_' . $plugin, $network_deactivating );
+			do_action( "deactivate_{$plugin}", $network_deactivating );
 
 			/**
 			 * Fires after a plugin is deactivated.
diff --git a/src/wp-admin/includes/revision.php b/src/wp-admin/includes/revision.php
@@ -70,10 +70,10 @@ function wp_get_revision_ui_diff( $post, $compare_from, $compare_to ) {
 		 * @param string  null                  The context of whether the current revision is the old
 		 *                                      or the new one. Values are 'to' or 'from'.
 		 */
-		$content_from = $compare_from ? apply_filters( "_wp_post_revision_field_$field", $compare_from->$field, $field, $compare_from, 'from' ) : '';
+		$content_from = $compare_from ? apply_filters( "_wp_post_revision_field_{$field}", $compare_from->$field, $field, $compare_from, 'from' ) : '';
 
 		/** This filter is documented in wp-admin/includes/revision.php */
-		$content_to = apply_filters( "_wp_post_revision_field_$field", $compare_to->$field, $field, $compare_to, 'to' );
+		$content_to = apply_filters( "_wp_post_revision_field_{$field}", $compare_to->$field, $field, $compare_to, 'to' );
 
 		$args = array(
 			'show_split_view' => true
diff --git a/src/wp-admin/media-upload.php b/src/wp-admin/media-upload.php
@@ -95,7 +95,7 @@
 	 *
 	 * @since 2.5.0
 	 */
-	do_action( "media_upload_$type" );
+	do_action( "media_upload_{$type}" );
 } else {
 	/**
 	 * Fires inside limited and specific upload-tab views in the legacy
@@ -107,6 +107,6 @@
 	 *
 	 * @since 2.5.0
 	 */
-	do_action( "media_upload_$tab" );
+	do_action( "media_upload_{$tab}" );
 }
 
diff --git a/src/wp-admin/plugin-install.php b/src/wp-admin/plugin-install.php
@@ -64,7 +64,7 @@
  *
  * @since 2.7.0
  */
-do_action( "install_plugins_pre_$tab" );
+do_action( "install_plugins_pre_{$tab}" );
 
 /*
  * Call the pre upload action on every non-upload plugin install screen
@@ -155,7 +155,7 @@
  *
  * @param int $paged The current page number of the plugins list table.
  */
-do_action( "install_plugins_$tab", $paged ); ?>
+do_action( "install_plugins_{$tab}", $paged ); ?>
 
 	<span class="spinner"></span>
 </div>
diff --git a/src/wp-includes/category-template.php b/src/wp-includes/category-template.php
@@ -1259,7 +1259,7 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = ''
 	 *
 	 * @param array $links An array of term links.
 	 */
-	$term_links = apply_filters( "term_links-$taxonomy", $links );
+	$term_links = apply_filters( "term_links-{$taxonomy}", $links );
 
 	return $before . join( $sep, $term_links ) . $after;
 }
diff --git a/src/wp-includes/class-wp-customize-control.php b/src/wp-includes/class-wp-customize-control.php
@@ -383,7 +383,7 @@ final public function maybe_render() {
 		 *
 		 * @param WP_Customize_Control $this WP_Customize_Control instance.
 		 */
-		do_action( 'customize_render_control_' . $this->id, $this );
+		do_action( "customize_render_control_{$this->id}", $this );
 
 		$this->render();
 	}
diff --git a/src/wp-includes/class-wp-rewrite.php b/src/wp-includes/class-wp-rewrite.php
@@ -1413,7 +1413,7 @@ public function rewrite_rules() {
 			 *
 			 * @param array $rules The rewrite rules generated for the current permastruct.
 			 */
-			$rules = apply_filters( $permastructname . '_rewrite_rules', $rules );
+			$rules = apply_filters( "{$permastructname}_rewrite_rules", $rules );
 			if ( 'post_tag' == $permastructname ) {
 
 				/**
diff --git a/src/wp-includes/option.php b/src/wp-includes/option.php
diff --git a/src/wp-includes/taxonomy.php b/src/wp-includes/taxonomy.php
diff --git a/src/wp-includes/theme.php b/src/wp-includes/theme.php
diff --git a/src/wp-login.php b/src/wp-login.php

Original file line number	Diff line number	Diff line change
`@@ -331,7 +331,7 @@`
`331`	`331`	`*`
`332`	`332`	`* @param WP_Post $post Post object.`
`333`	`333`	`*/`
`334`		`-do_action( 'add_meta_boxes_' . $post_type, $post );`
	`334`	`+do_action( "add_meta_boxes_{$post_type}", $post );`
`335`	`335`
`336`	`336`	`/**`
`337`	`337`	`* Fires after meta boxes have been added.`
Original file line number	Diff line number	Diff line change
`@@ -518,7 +518,7 @@ public function column_name( $theme ) {`
`518`	`518`	`* @param WP_Theme $theme The current WP_Theme object.`
`519`	`519`	`* @param string $context Status of the theme.`
`520`	`520`	`*/`
`521`		`- $actions = apply_filters( "theme_action_links_$stylesheet", $actions, $theme, $context );`
	`521`	`+ $actions = apply_filters( "theme_action_links_{$stylesheet}", $actions, $theme, $context );`
`522`	`522`
`523`	`523`	`echo $this->row_actions( $actions, true );`
`524`	`524`	`}`
`@@ -726,6 +726,6 @@ public function single_row( $theme ) {`
`726`	`726`	`* @param WP_Theme $theme Current WP_Theme object.`
`727`	`727`	`* @param string $status Status of the theme.`
`728`	`728`	`*/`
`729`		`- do_action( "after_theme_row_$stylesheet", $stylesheet, $theme, $status );`
	`729`	`+ do_action( "after_theme_row_{$stylesheet}", $stylesheet, $theme, $status );`
`730`	`730`	`}`
`731`	`731`	`}`
Original file line number	Diff line number	Diff line change
`@@ -200,7 +200,7 @@ public function prepare_items() {`
`200`	`200`	`*`
`201`	`201`	`* @param array\|bool $args Plugin Install API arguments.`
`202`	`202`	`*/`
`203`		`- $args = apply_filters( "install_plugins_table_api_args_$tab", $args );`
	`203`	`+ $args = apply_filters( "install_plugins_table_api_args_{$tab}", $args );`
`204`	`204`
`205`	`205`	`if ( !$args )`
`206`	`206`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -864,7 +864,7 @@ public function single_row( $item ) {`
`864`	`864`	`* 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',`
`865`	`865`	`* 'Drop-ins', 'Search'.`
`866`	`866`	`*/`
`867`		`- do_action( "after_plugin_row_$plugin_file", $plugin_file, $plugin_data, $status );`
	`867`	`+ do_action( "after_plugin_row_{$plugin_file}", $plugin_file, $plugin_data, $status );`
`868`	`868`	`}`
`869`	`869`
`870`	`870`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ public function prepare_items() {`
`134`	`134`	`*`
`135`	`135`	`* @param array $args An array of themes API arguments.`
`136`	`136`	`*/`
`137`		`- $args = apply_filters( 'install_themes_table_api_args_' . $tab, $args );`
	`137`	`+ $args = apply_filters( "install_themes_table_api_args_{$tab}", $args );`
`138`	`138`
`139`	`139`	`if ( ! $args )`
`140`	`140`	`return;`