Changeset 30656 for trunk/src/wp-includes/template.php

Timestamp:

11/30/2014 12:09:56 PM (11 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/template.php (modified) (2 diffs)

trunk/src/wp-includes/template.php

@@ -31 +31 @@
      * 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.
@@ -37 +37 @@
      * @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 );