Docs Formatting: Backtick-escape inline code for all remaining dynamic hook docs in wp-includes/*.

Affects DocBlocks for the following hooks:
* `auth_post_meta_{$meta_key}`
* `term_links-$taxonomy`
* `customize_render_control_ . $this->id`
* `customize_render_panel_{$this->id}`
* `customize_render_section_{$this->id}`
* `customize_preview_{$this->id}`
* `customize_save_ . $this->id_data[ 'base' ]`
* `customize_update_ . $this->type`
* `customize_value_ . $this->id_data[ 'base' ]`
* `customize_sanitize_js_{$this->id}`
* `comment_form_field_{$name}`
* `comment_{$old_status}_to_{$new_status}`
* `comment_{$new_status}_{$comment->comment_type}`
* `extra_{$context}_headers`
* `get_template_part_{$slug}`
* `get_the_generator_{$type}`
* `get_{$adjacent}_post_join`
* `get_{$adjacent}_post_where`
* `get_{$adjacent}_post_sort`
* `{$adjacent}_post_rel_link`
* `{$adjacent}_post_link`
* `{$adjacent}_image_link`
* `blog_option_{$option}`
* `$permastructname . _rewrite_rules`
* `{$type}_template`
* `theme_mod_{$name}`
* `pre_set_theme_mod_$name`
* `current_theme_supports-{$feature}`
* `get_user_option_{$option}`
* `edit_user_{$field}`
* `pre_user_{$field}`
* `user_{$field}`

See #30552.

Built from https://develop.svn.wordpress.org/trunk@30656


git-svn-id: http://core.svn.wordpress.org/trunk@30646 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-includes/capabilities.php

@@ -1204,8 +1204,8 @@ function map_meta_cap( $cap, $user_id ) {
 			/**
 			 * Filter whether the user is allowed to add post meta to a post.
 			 *
-			 * The dynamic portion of the hook name, $meta_key, refers to the
+			 * The dynamic portion of the hook name, `$meta_key`, refers to the
-			 * meta key passed to map_meta_cap().
+			 * meta key passed to {@see map_meta_cap()}.
 			 *
 			 * @since 3.3.0
 			 *

wp-includes/category-template.php

@@ -1299,7 +1299,7 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = ''
 	/**
 	 * Filter the term links for a given taxonomy.
 	 *
-	 * The dynamic portion of the filter name, $taxonomy, refers
+	 * The dynamic portion of the filter name, `$taxonomy`, refers
 	 * to the taxonomy slug.
 	 *
 	 * @since 2.5.0

wp-includes/class-wp-customize-control.php

@@ -320,12 +320,12 @@ class WP_Customize_Control {
 		/**
 		 * Fires just before a specific Customizer control is rendered.
 		 *
-		 * The dynamic portion of the hook name, $this->id, refers to
+		 * The dynamic portion of the hook name, `$this->id`, refers to
 		 * the control ID.
 		 *
 		 * @since 3.4.0
 		 *
-		 * @param WP_Customize_Control $this WP_Customize_Control instance.
+		 * @param WP_Customize_Control $this {@see WP_Customize_Control} instance.
 		 */
 		do_action( 'customize_render_control_' . $this->id, $this );
 

wp-includes/class-wp-customize-panel.php

@@ -268,8 +268,8 @@ class WP_Customize_Panel {
 		/**
 		 * Fires before rendering a specific Customizer panel.
 		 *
-		 * The dynamic portion of the hook name, $this->id, refers to the ID
+		 * The dynamic portion of the hook name, `$this->id`, refers to
-		 * of the specific Customizer panel to be rendered.
+		 * the ID of the specific Customizer panel to be rendered.
 		 *
 		 * @since 4.0.0
 		 */

wp-includes/class-wp-customize-section.php

@@ -276,7 +276,7 @@ class WP_Customize_Section {
 		/**
 		 * Fires before rendering a specific Customizer section.
 		 *
-		 * The dynamic portion of the hook name, $this->id, refers to the ID
+		 * The dynamic portion of the hook name, `$this->id`, refers to the ID
 		 * of the specific Customizer section to be rendered.
 		 *
 		 * @since 3.4.0

wp-includes/class-wp-customize-setting.php

@@ -127,11 +127,11 @@ class WP_Customize_Setting {
 				 * Fires when the {@see WP_Customize_Setting::preview()} method is called for settings
 				 * not handled as theme_mods or options.
 				 *
-				 * The dynamic portion of the hook name, $this->id, refers to the setting ID.
+				 * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
 				 *
 				 * @since 3.4.0
 				 *
-				 * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+				 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
 				 */
 				do_action( "customize_preview_{$this->id}", $this );
 
@@ -179,12 +179,12 @@ class WP_Customize_Setting {
 		/**
 		 * Fires when the WP_Customize_Setting::save() method is called.
 		 *
-		 * The dynamic portion of the hook name, $this->id_data['base'] refers to
+		 * The dynamic portion of the hook name, `$this->id_data['base']` refers to
 		 * the base slug of the setting name.
 		 *
 		 * @since 3.4.0
 		 *
-		 * @param WP_Customize_Setting $this WP_Customize_Setting instance.
+		 * @param WP_Customize_Setting $this {@see WP_Customize_Setting} instance.
 		 */
 		do_action( 'customize_save_' . $this->id_data[ 'base' ], $this );
 
@@ -254,10 +254,10 @@ class WP_Customize_Setting {
 			default :
 
 				/**
-				 * Fires when the WP_Customize_Setting::update() method is called for settings
+				 * Fires when the {@see WP_Customize_Setting::update()} method is called for settings
 				 * not handled as theme_mods or options.
 				 *
-				 * The dynamic portion of the hook name, $this->type, refers to the type of setting.
+				 * The dynamic portion of the hook name, `$this->type`, refers to the type of setting.
 				 *
 				 * @since 3.4.0
 				 *
@@ -329,7 +329,7 @@ class WP_Customize_Setting {
 				/**
 				 * Filter a Customize setting value not handled as a theme_mod or option.
 				 *
-				 * The dynamic portion of the hook name, $this->id_date['base'], refers to
+				 * The dynamic portion of the hook name, `$this->id_date['base']`, refers to
 				 * the base slug of the setting name.
 				 *
 				 * For settings handled as theme_mods or options, see those corresponding
@@ -363,12 +363,12 @@ class WP_Customize_Setting {
 		/**
 		 * Filter a Customize setting value for use in JavaScript.
 		 *
-		 * The dynamic portion of the hook name, $this->id, refers to the setting ID.
+		 * The dynamic portion of the hook name, `$this->id`, refers to the setting ID.
 		 *
 		 * @since 3.4.0
 		 *
 		 * @param mixed                $value The setting value.
-		 * @param WP_Customize_Setting $this  WP_Customize_Setting instance.
+		 * @param WP_Customize_Setting $this  {@see WP_Customize_Setting} instance.
 		 */
 		$value = apply_filters( "customize_sanitize_js_{$this->id}", $this->value(), $this );
 

wp-includes/comment-template.php

@@ -2301,7 +2301,7 @@ function comment_form( $args = array(), $post_id = null ) {
 								/**
 								 * Filter a comment form field for display.
 								 *
-								 * The dynamic portion of the filter hook, $name, refers to the name
+								 * The dynamic portion of the filter hook, `$name`, refers to the name
 								 * of the comment form field. Such as 'author', 'email', or 'url'.
 								 *
 								 * @since 3.0.0

wp-includes/comment.php

@@ -1818,7 +1818,7 @@ function wp_transition_comment_status($new_status, $old_status, $comment) {
 		/**
 		 * Fires when the comment status is in transition from one specific status to another.
 		 *
-		 * The dynamic portions of the hook name, $old_status, and $new_status,
+		 * The dynamic portions of the hook name, `$old_status`, and `$new_status`,
 		 * refer to the old and new comment statuses, respectively.
 		 *
 		 * @since 2.7.0
@@ -1830,7 +1830,7 @@ function wp_transition_comment_status($new_status, $old_status, $comment) {
 	/**
 	 * Fires when the status of a specific comment type is in transition.
 	 *
-	 * The dynamic portions of the hook name, $new_status, and $comment->comment_type,
+	 * The dynamic portions of the hook name, `$new_status`, and `$comment->comment_type`,
 	 * refer to the new comment status, and the type of comment, respectively.
 	 *
 	 * Typical comment types include an empty string (standard comment), 'pingback',

wp-includes/functions.php

@@ -4194,8 +4194,8 @@ function get_file_data( $file, $default_headers, $context = '' ) {
 	/**
 	 * Filter extra file headers by context.
 	 *
-	 * The dynamic portion of the hook name, $context, refers to the context
+	 * The dynamic portion of the hook name, `$context`, refers to
-	 * where extra headers might be loaded.
+	 * the context where extra headers might be loaded.
 	 *
 	 * @since 2.9.0
 	 *

wp-includes/general-template.php

@@ -151,7 +151,7 @@ function get_template_part( $slug, $name = null ) {
 	/**
 	 * Fires before the specified template part file is loaded.
 	 *
-	 * The dynamic portion of the hook name, $slug, refers to the slug name
+	 * The dynamic portion of the hook name, `$slug`, refers to the slug name
 	 * for the generic template part.
 	 *
 	 * @since 3.0.0
@@ -3009,11 +3009,11 @@ function get_the_generator( $type = '' ) {
 	/**
 	 * Filter the HTML for the retrieved generator type.
 	 *
-	 * The dynamic portion of the hook name, $type, refers to the generator type.
+	 * The dynamic portion of the hook name, `$type`, refers to the generator type.
 	 *
 	 * @since 2.5.0
 	 *
-	 * @param string $gen  The HTML markup output to 'wp_head()'.
+	 * @param string $gen  The HTML markup output to {@see wp_head()}.
 	 * @param string $type The type of generator. Accepts 'html', 'xhtml', 'atom',
 	 *                     'rss2', 'rdf', 'comment', 'export'.
 	 */

wp-includes/link-template.php

@@ -1524,7 +1524,7 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
 	/**
 	 * Filter the JOIN clause in the SQL for an adjacent post query.
 	 *
-	 * The dynamic portion of the hook name, $adjacent, refers to the type
+	 * The dynamic portion of the hook name, `$adjacent`, refers to the type
 	 * of adjacency, 'next' or 'previous'.
 	 *
 	 * @since 2.5.0
@@ -1538,12 +1538,12 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
 	/**
 	 * Filter the WHERE clause in the SQL for an adjacent post query.
 	 *
-	 * The dynamic portion of the hook name, $adjacent, refers to the type
+	 * The dynamic portion of the hook name, `$adjacent`, refers to the type
 	 * of adjacency, 'next' or 'previous'.
 	 *
 	 * @since 2.5.0
 	 *
-	 * @param string $where          The WHERE clause in the SQL.
+	 * @param string $where          The `WHERE` clause in the SQL.
 	 * @param bool   $in_same_term   Whether post should be in a same taxonomy term.
 	 * @param array  $excluded_terms Array of excluded term IDs.
 	 */
@@ -1552,12 +1552,12 @@ function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previo
 	/**
 	 * Filter the ORDER BY clause in the SQL for an adjacent post query.
 	 *
-	 * The dynamic portion of the hook name, $adjacent, refers to the type
+	 * The dynamic portion of the hook name, `$adjacent`, refers to the type
 	 * of adjacency, 'next' or 'previous'.
 	 *
 	 * @since 2.5.0
 	 *
-	 * @param string $order_by The ORDER BY clause in the SQL.
+	 * @param string $order_by The `ORDER BY` clause in the SQL.
 	 */
 	$sort  = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1" );
 
@@ -1624,7 +1624,7 @@ function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $
 	/**
 	 * Filter the adjacent post relational link.
 	 *
-	 * The dynamic portion of the hook name, $adjacent, refers to the type
+	 * The dynamic portion of the hook name, `$adjacent`, refers to the type
 	 * of adjacency, 'next' or 'previous'.
 	 *
 	 * @since 2.8.0
@@ -1861,7 +1861,7 @@ function get_adjacent_post_link( $format, $link, $in_same_term = false, $exclude
 	/**
 	 * Filter the adjacent post link.
 	 *
-	 * The dynamic portion of the hook name, $adjacent, refers to the type
+	 * The dynamic portion of the hook name, `$adjacent`, refers to the type
 	 * of adjacency, 'next' or 'previous'.
 	 *
 	 * @since 2.6.0

wp-includes/media.php

@@ -1942,7 +1942,7 @@ function adjacent_image_link($prev = true, $size = 'thumbnail', $text = false) {
 	/**
 	 * Filter the adjacent image link.
 	 *
-	 * The dynamic portion of the hook name, $adjacent, refers to the type of adjacency,
+	 * The dynamic portion of the hook name, `$adjacent`, refers to the type of adjacency,
 	 * either 'next', or 'previous'.
 	 *
 	 * @since 3.5.0

wp-includes/ms-blogs.php

@@ -460,7 +460,7 @@ function get_blog_option( $id, $option, $default = false ) {
 	/**
 	 * Filter a blog option value.
 	 *
-	 * The dynamic portion of the hook name, $option, refers to the blog option name.
+	 * The dynamic portion of the hook name, `$option`, refers to the blog option name.
 	 *
 	 * @since 3.5.0
 	 *

wp-includes/rewrite.php

@@ -1676,7 +1676,7 @@ class WP_Rewrite {
 			/**
 			 * Filter rewrite rules used for individual permastructs.
 			 *
-			 * The dynamic portion of the hook name, $permastructname, refers
+			 * The dynamic portion of the hook name, `$permastructname`, refers
 			 * to the name of the registered permastruct, e.g. 'post_tag' (tags),
 			 * 'category' (categories), etc.
 			 *

wp-includes/template.php

@@ -30,13 +30,13 @@ function get_query_template( $type, $templates = array() ) {
 	/**
 	 * Filter the path of the queried template by type.
 	 *
-	 * The dynamic portion of the hook name, $type, refers to the filename
+	 * The dynamic portion of the hook name, `$type`, refers to the filename
 	 * -- minus the extension -- of the file to load. This hook also applies
 	 * to various types of files loaded as part of the Template Hierarchy.
 	 *
 	 * @since 1.5.0
 	 *
-	 * @param string $template Path to the template. @see locate_template()
+	 * @param string $template Path to the template. See {@see locate_template()}.
 	 */
 	return apply_filters( "{$type}_template", $template );
 }

wp-includes/theme.php

@@ -909,7 +909,7 @@ function get_theme_mod( $name, $default = false ) {
 		/**
 		 * Filter the theme modification, or 'theme_mod', value.
 		 *
-		 * The dynamic portion of the hook name, $name, refers to
+		 * The dynamic portion of the hook name, `$name`, refers to
 		 * the key name of the modification array. For example,
 		 * 'header_textcolor', 'header_image', and so on depending
 		 * on the theme options.
@@ -943,7 +943,7 @@ function set_theme_mod( $name, $value ) {
 	/**
 	 * Filter the theme mod value on save.
 	 *
-	 * The dynamic portion of the hook name, $name, refers to the key name of
+	 * The dynamic portion of the hook name, `$name`, refers to the key name of
 	 * the modification array. For example, 'header_textcolor', 'header_image',
 	 * and so on depending on the theme options.
 	 *
@@ -1816,10 +1816,9 @@ function current_theme_supports( $feature ) {
 	/**
 	 * Filter whether the current theme supports a specific feature.
 	 *
-	 * The dynamic portion of the hook name, $feature, refers to
+	 * The dynamic portion of the hook name, `$feature`, refers to the specific theme
-	 * the specific theme feature. Possible values include 'post-formats',
+	 * feature. Possible values include 'post-formats', 'post-thumbnails', 'custom-background',
-	 * 'post-thumbnails', 'custom-background', 'custom-header', 'menus',
+	 * 'custom-header', 'menus', 'automatic-feed-links', and 'html5'.
-	 * 'automatic-feed-links', and 'html5'.
 	 *
 	 * @since 3.4.0
 	 *

wp-includes/user.php

@@ -371,7 +371,7 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) {
 	/**
 	 * Filter a specific user option value.
 	 *
-	 * The dynamic portion of the hook name, $option, refers to the user option name.
+	 * The dynamic portion of the hook name, `$option`, refers to the user option name.
 	 *
 	 * @since 2.5.0
 	 *
@@ -1499,7 +1499,7 @@ function sanitize_user_field($field, $value, $user_id, $context) {
 			/**
 			 * Filter a user field value in the 'edit' context.
 			 *
-			 * The dynamic portion of the hook name, $field, refers to the prefixed user
+			 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
 			 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
 			 *
 			 * @since 2.9.0
@@ -1523,7 +1523,7 @@ function sanitize_user_field($field, $value, $user_id, $context) {
 			/**
 			 * Filter the value of a user field in the 'db' context.
 			 *
-			 * The dynamic portion of the hook name, $field, refers to the prefixed user
+			 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
 			 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
  			 *
 			 * @since 2.9.0
@@ -1543,7 +1543,7 @@ function sanitize_user_field($field, $value, $user_id, $context) {
 			/**
 			 * Filter the value of a user field in a standard context.
 			 *
-			 * The dynamic portion of the hook name, $field, refers to the prefixed user
+			 * The dynamic portion of the hook name, `$field`, refers to the prefixed user
 			 * field being filtered, such as 'user_login', 'user_email', 'first_name', etc.
 			 *
 			 * @since 2.9.0

wp-includes/version.php

@@ -4,7 +4,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '4.1-beta2-30655';
+$wp_version = '4.1-beta2-30656';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.