Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-22 17:18:32 +01:00
Code Issues Projects Releases Wiki Activity

Docs: Apply inline @see tags to hooks referenced in DocBlocks in wp-includes/general-template.php.

Browse Source 
Applying these specially-crafted `@see` tags allows the Code Reference parser to recognize and link these elements as actions and filters.

See #36921.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37509 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-05-23 18:57:28 +00:00
parent e0408b36ca
commit 9549a46d7c
2 changed files with 27 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
wp-includes/general-template.php
View File

@ -174,13 +174,13 @@ function get_template_part( $slug, $name = null ) {
* the parent, then load it. If it doesn't exist, then the default search form
* will be displayed. The default search form is HTML, which will be displayed.
* There is a filter applied to the search form HTML in order to edit or replace
* it. The filter is 'get_search_form'.
* it. The filter is {@see 'get_search_form'}.
*
* This function is primarily used by themes which want to hardcode the search
* form into the sidebar and also by the search widget in WordPress.
*
* There is also an action that is called whenever the function is run called,
* 'pre_get_search_form'. This can be useful for outputting JavaScript that the
* {@see 'pre_get_search_form'}. This can be useful for outputting JavaScript that the
* search relies on or various formatting that applies to the beginning of the
* search. To give a few examples of what it can be used for.
*
@ -566,7 +566,7 @@ function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {
/**
* Theme container function for the 'wp_meta' action.
*
* The 'wp_meta' action can have several purposes, depending on how you use it,
* The {@see 'wp_meta'} action can have several purposes, depending on how you use it,
* but one purpose might have been to allow for theme switching.
*
* @since 1.5.0
@ -2180,7 +2180,7 @@ function the_date( $d = '', $before = '', $after = '', $echo = true ) {
* Retrieve the date on which the post was written.
*
* Unlike the_date() this function will always return the date.
* Modify output with 'get_the_date' filter.
* Modify output with the {@see 'get_the_date'} filter.
*
* @since 3.0.0
*
@ -2515,7 +2515,9 @@ function the_weekday_date($before='',$after='') {
}
/**
* Fire the wp_head action
* Fire the wp_head action.
*
* See {@see 'wp_head'}.
*
* @since 1.2.0
*/
@ -2529,7 +2531,9 @@ function wp_head() {
}
/**
* Fire the wp_footer action
* Fire the wp_footer action.
*
* See {@see 'wp_footer'}.
*
* @since 1.5.1
*/
@ -2692,11 +2696,15 @@ function wlwmanifest_link() {
}
/**
* Display a noindex meta tag if required by the blog configuration.
* Displays a noindex meta tag if required by the blog configuration.
*
* If a blog is marked as not being public then the noindex meta tag will be
* output to tell web robots not to index the page content. Add this to the wp_head action.
* Typical usage is as a wp_head callback. add_action( 'wp_head', 'noindex' );
* output to tell web robots not to index the page content. Add this to the
* {@see 'wp_head'} action.
*
* Typical usage is as a {@see 'wp_head'} callback:
*
* add_action( 'wp_head', 'noindex' );
*
* @see wp_no_robots
*
@ -3272,9 +3280,9 @@ function register_admin_color_schemes() {
}
/**
* Display the URL of a WordPress admin CSS file.
* Displays the URL of a WordPress admin CSS file.
*
* @see WP_Styles::_css_href and its style_loader_src filter.
* @see WP_Styles::_css_href and its {@see 'style_loader_src'} filter.
*
* @since 2.3.0
*
@ -3304,8 +3312,8 @@ function wp_admin_css_uri( $file = 'wp-admin' ) {
* Enqueues or directly prints a stylesheet link to the specified CSS file.
*
* "Intelligently" decides to enqueue or to print the CSS file. If the
* 'wp_print_styles' action has *not* yet been called, the CSS file will be
* enqueued. If the wp_print_styles action *has* been called, the CSS link will
* {@see 'wp_print_styles'} action has *not* yet been called, the CSS file will be
* enqueued. If the {@see 'wp_print_styles'} action has been called, the CSS link will
* be printed. Printing may be forced by passing true as the $force_echo
* (second) parameter.
*
@ -3369,7 +3377,9 @@ function add_thickbox() {
}
/**
* Display the XHTML generator that is generated on the wp_head hook.
* Displays the XHTML generator that is generated on the wp_head hook.
*
* See {@see 'wp_head'}.
*
* @since 2.5.0
*/
@ -3388,7 +3398,7 @@ function wp_generator() {
* Display the generator XML or Comment for RSS, ATOM, etc.
*
* Returns the correct generator type for the requested output format. Allows
* for a plugin to filter generators overall the the_generator filter.
* for a plugin to filter generators overall the {@see 'the_generator'} filter.
*
* @since 2.5.0
*
@ -3412,7 +3422,7 @@ function the_generator( $type ) {
*
* Returns the correct generator type for the requested output format. Allows
* for a plugin to filter generators on an individual basis using the
* 'get_the_generator_{$type}' filter.
* {@see 'get_the_generator_$type'} filter.
*
* @since 2.5.0
*

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.6-alpha-37540';
$wp_version = '4.6-alpha-37541';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.