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 a variety of wp-includes/* files.

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@37543


git-svn-id: http://core.svn.wordpress.org/trunk@37511 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-05-23 19:01:27 +00:00
parent da78aeffe9
commit d28f1a08ef
10 changed files with 47 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-includes/embed.php
View File

@ -50,7 +50,7 @@ function wp_embed_unregister_handler( $id, $priority = 10 ) {
* *
* The default height is 1.5 times the width, or 1000px, whichever is smaller. * The default height is 1.5 times the width, or 1000px, whichever is smaller.
* *
* The 'embed_defaults' filter can be used to adjust either of these values. * The {@see 'embed_defaults'} filter can be used to adjust either of these values.
* *
* @since 2.9.0 * @since 2.9.0
* *

2
wp-includes/feed.php
View File

@ -68,7 +68,7 @@ function bloginfo_rss($show = '') {
* Retrieve the default feed. * Retrieve the default feed.
* *
* The default feed is 'rss2', unless a plugin changes it through the * The default feed is 'rss2', unless a plugin changes it through the
* 'default_feed' filter. * {@see 'default_feed'} filter.
* *
* @since 2.5.0 * @since 2.5.0
* *

18
wp-includes/formatting.php
View File

@ -20,7 +20,7 @@
* *
* Code within certain html blocks are skipped. * Code within certain html blocks are skipped.
* *
* Do not use this function before the 'init' action hook; everything will break. * Do not use this function before the {@see 'init'} action hook; everything will break.
* *
* @since 0.71 * @since 0.71
* *
@ -1441,7 +1441,7 @@ function sanitize_file_name( $filename ) {
* Removes tags, octets, entities, and if strict is enabled, will only keep * Removes tags, octets, entities, and if strict is enabled, will only keep
* alphanumeric, _, space, ., -, @. After sanitizing, it passes the username, * alphanumeric, _, space, ., -, @. After sanitizing, it passes the username,
* raw username (the username in the parameter), and the value of $strict as * raw username (the username in the parameter), and the value of $strict as
* parameters for the 'sanitize_user' filter. * parameters for the {@see 'sanitize_user'} filter.
* *
* @since 2.0.0 * @since 2.0.0
* *
@ -1904,8 +1904,8 @@ function force_balance_tags( $text ) {
* Acts on text which is about to be edited. * Acts on text which is about to be edited.
* *
* The $content is run through esc_textarea(), which uses htmlspecialchars() * The $content is run through esc_textarea(), which uses htmlspecialchars()
* to convert special characters to HTML entities. If $richedit is set to true, * to convert special characters to HTML entities. If `$richedit` is set to true,
* it is simply a holder for the 'format_to_edit' filter. * it is simply a holder for the {@see 'format_to_edit'} filter.
* *
* @since 0.71 * @since 0.71
* @since 4.4.0 The `$richedit` parameter was renamed to `$rich_text` for clarity. * @since 4.4.0 The `$richedit` parameter was renamed to `$rich_text` for clarity.
@ -2877,8 +2877,8 @@ function human_time_diff( $from, $to = '' ) {
* that, then the string ' […]' will be appended to the excerpt. If the string * that, then the string ' […]' will be appended to the excerpt. If the string
* is less than 55 words, then the content will be returned as is. * is less than 55 words, then the content will be returned as is.
* *
* The 55 word limit can be modified by plugins/themes using the excerpt_length filter * The 55 word limit can be modified by plugins/themes using the {@see 'excerpt_length'} filter
* The ' […]' string can be modified by plugins/themes using the excerpt_more filter * The ' […]' string can be modified by plugins/themes using the {@see 'excerpt_more'} filter
* *
* @since 1.5.0 * @since 1.5.0
* *
@ -3353,7 +3353,7 @@ function esc_sql( $data ) {
* Checks and cleans a URL. * Checks and cleans a URL.
* *
* A number of characters are removed from the URL. If the URL is for displaying * A number of characters are removed from the URL. If the URL is for displaying
* (the default behaviour) ampersands are also replaced. The 'clean_url' filter * (the default behaviour) ampersands are also replaced. The {@see 'clean_url'} filter
* is applied to the returned cleaned URL. * is applied to the returned cleaned URL.
* *
* @since 2.8.0 * @since 2.8.0
@ -3362,7 +3362,7 @@ function esc_sql( $data ) {
* @param array $protocols Optional. An array of acceptable protocols. * @param array $protocols Optional. An array of acceptable protocols.
* Defaults to return value of wp_allowed_protocols() * Defaults to return value of wp_allowed_protocols()
* @param string $_context Private. Use esc_url_raw() for database usage. * @param string $_context Private. Use esc_url_raw() for database usage.
* @return string The cleaned $url after the 'clean_url' filter is applied. * @return string The cleaned $url after the {@see 'clean_url'} filter is applied.
*/ */
function esc_url( $url, $protocols = null, $_context = 'display' ) { function esc_url( $url, $protocols = null, $_context = 'display' ) {
$original_url = $url; $original_url = $url;
@ -3491,7 +3491,7 @@ function htmlentities2( $myHTML ) {
* *
* Escapes text strings for echoing in JS. It is intended to be used for inline JS * Escapes text strings for echoing in JS. It is intended to be used for inline JS
* (in a tag attribute, for example onclick="..."). Note that the strings have to * (in a tag attribute, for example onclick="..."). Note that the strings have to
* be in single quotes. The filter 'js_escape' is also applied here. * be in single quotes. The {@see 'js_escape'} filter is also applied here.
* *
* @since 2.8.0 * @since 2.8.0
* *

22
wp-includes/functions.php
View File

@ -2318,7 +2318,7 @@ function wp_get_mime_types() {
* Filters the list of mime types and file extensions. * Filters the list of mime types and file extensions.
* *
* This filter should be used to add, not remove, mime types. To remove * This filter should be used to add, not remove, mime types. To remove
* mime types, use the 'upload_mimes' filter. * mime types, use the {@see 'upload_mimes'} filter.
* *
* @since 3.5.0 * @since 3.5.0
* *
@ -2591,10 +2591,10 @@ function wp_die( $message = '', $title = '', $args = array() ) {
} }
/** /**
* Kill WordPress execution and display HTML message with error message. * Kills WordPress execution and display HTML message with error message.
* *
* This is the default handler for wp_die if you want a custom one for your * This is the default handler for wp_die if you want a custom one for your
* site then you can overload using the wp_die_handler filter in wp_die * site then you can overload using the {@see 'wp_die_handler'} filter in wp_die().
* *
* @since 3.0.0 * @since 3.0.0
* @access private * @access private
@ -3630,11 +3630,11 @@ function absint( $maybeint ) {
/** /**
* Mark a function as deprecated and inform when it has been used. * Mark a function as deprecated and inform when it has been used.
* *
* There is a hook deprecated_function_run that will be called that can be used * There is a {@see 'hook deprecated_function_run'} that will be called that can be used
* to get the backtrace up to what file and function called the deprecated * to get the backtrace up to what file and function called the deprecated
* function. * function.
* *
* The current behavior is to trigger a user error if WP_DEBUG is true. * The current behavior is to trigger a user error if `WP_DEBUG` is true.
* *
* This function is to be used in every function that is deprecated. * This function is to be used in every function that is deprecated.
* *
@ -3750,11 +3750,11 @@ function _deprecated_constructor( $class, $version, $parent_class = '' ) {
/** /**
* Mark a file as deprecated and inform when it has been used. * Mark a file as deprecated and inform when it has been used.
* *
* There is a hook deprecated_file_included that will be called that can be used * There is a hook {@see 'deprecated_file_included'} that will be called that can be used
* to get the backtrace up to what file and function included the deprecated * to get the backtrace up to what file and function included the deprecated
* file. * file.
* *
* The current behavior is to trigger a user error if WP_DEBUG is true. * The current behavior is to trigger a user error if `WP_DEBUG` is true.
* *
* This function is to be used in every file that is deprecated. * This function is to be used in every file that is deprecated.
* *
@ -3867,11 +3867,11 @@ function _deprecated_argument( $function, $version, $message = null ) {
/** /**
* Mark something as being incorrectly called. * Mark something as being incorrectly called.
* *
* There is a hook doing_it_wrong_run that will be called that can be used * There is a hook {@see 'doing_it_wrong_run'} that will be called that can be used
* to get the backtrace up to what file and function called the deprecated * to get the backtrace up to what file and function called the deprecated
* function. * function.
* *
* The current behavior is to trigger a user error if WP_DEBUG is true. * The current behavior is to trigger a user error if `WP_DEBUG` is true.
* *
* @since 3.1.0 * @since 3.1.0
* @access private * @access private
@ -4572,7 +4572,7 @@ function wp_scheduled_delete() {
* *
* @param string $file Path to the file. * @param string $file Path to the file.
* @param array $default_headers List of headers, in the format array('HeaderKey' => 'Header Name'). * @param array $default_headers List of headers, in the format array('HeaderKey' => 'Header Name').
* @param string $context Optional. If specified adds filter hook "extra_{$context}_headers". * @param string $context Optional. If specified adds filter hook {@see 'extra_$context_headers'}.
* Default empty. * Default empty.
* @return array Array of file headers in `HeaderKey => Header Value` format. * @return array Array of file headers in `HeaderKey => Header Value` format.
*/ */
@ -4992,7 +4992,7 @@ function wp_checkdate( $month, $day, $year, $source_date ) {
* Can be disabled with remove_action( 'admin_enqueue_scripts', 'wp_auth_check_load' ); * Can be disabled with remove_action( 'admin_enqueue_scripts', 'wp_auth_check_load' );
* *
* This is disabled for certain screens where a login screen could cause an * This is disabled for certain screens where a login screen could cause an
* inconvenient interruption. A filter called wp_auth_check_load can be used * inconvenient interruption. A filter called {@see 'wp_auth_check_load'} can be used
* for fine-grained control. * for fine-grained control.
* *
* @since 3.6.0 * @since 3.6.0

6
wp-includes/functions.wp-scripts.php
View File

@ -47,11 +47,11 @@ function _wp_scripts_maybe_doing_it_wrong( $function ) {
} }
/** /**
* Print scripts in document head that are in the $handles queue. * Prints scripts in document head that are in the $handles queue.
* *
* Called by admin-header.php and wp_head hook. Since it is called by wp_head on every page load, * Called by admin-header.php and {@see 'wp_head'} hook. Since it is called by wp_head on every page load,
* the function does not instantiate the WP_Scripts object unless script names are explicitly passed. * the function does not instantiate the WP_Scripts object unless script names are explicitly passed.
* Makes use of already-instantiated $wp_scripts global if present. Use provided wp_print_scripts * Makes use of already-instantiated $wp_scripts global if present. Use provided {@see 'wp_print_scripts'}
* hook to register/enqueue new scripts. * hook to register/enqueue new scripts.
* *
* @see WP_Scripts::do_items() * @see WP_Scripts::do_items()

4
wp-includes/http.php
View File

@ -581,7 +581,7 @@ function wp_http_validate_url( $url ) {
/** /**
* Whitelists allowed redirect hosts for safe HTTP requests as well. * Whitelists allowed redirect hosts for safe HTTP requests as well.
* *
* Attached to the http_request_host_is_external filter. * Attached to the {@see 'http_request_host_is_external'} filter.
* *
* @since 3.6.0 * @since 3.6.0
* *
@ -598,7 +598,7 @@ function allowed_http_request_hosts( $is_external, $host ) {
/** /**
* Whitelists any domain in a multisite installation for safe HTTP requests. * Whitelists any domain in a multisite installation for safe HTTP requests.
* *
* Attached to the http_request_host_is_external filter. * Attached to the {@see 'http_request_host_is_external'} filter.
* *
* @since 3.6.0 * @since 3.6.0
* *

19
wp-includes/kses.php
View File

@ -34,8 +34,9 @@
/** /**
* You can override this in a plugin. * You can override this in a plugin.
* *
* The wp_kses_allowed_html filter is more powerful and supplies context. * The {@see 'wp_kses_allowed_html'} filter is more powerful and supplies context.
* CUSTOM_TAGS is not recommended and should be considered deprecated. *
* `CUSTOM_TAGS` is not recommended and should be considered deprecated.
* *
* @see wp_kses_allowed_html() * @see wp_kses_allowed_html()
* *
@ -667,15 +668,15 @@ function wp_kses_allowed_html( $context = '' ) {
/** /**
* You add any kses hooks here. * You add any kses hooks here.
* *
* There is currently only one kses WordPress hook and it is called here. All * There is currently only one kses WordPress hook, {@see 'pre_kses'}, and it is called here.
* parameters are passed to the hooks and expected to receive a string. * All parameters are passed to the hooks and expected to receive a string.
* *
* @since 1.0.0 * @since 1.0.0
* *
* @param string $string Content to filter through kses * @param string $string Content to filter through kses
* @param array $allowed_html List of allowed HTML elements * @param array $allowed_html List of allowed HTML elements
* @param array $allowed_protocols Allowed protocol in links * @param array $allowed_protocols Allowed protocol in links
* @return string Filtered content through 'pre_kses' hook * @return string Filtered content through {@see 'pre_kses'} hook.
*/ */
function wp_kses_hook( $string, $allowed_html, $allowed_protocols ) { function wp_kses_hook( $string, $allowed_html, $allowed_protocols ) {
/** /**
@ -1641,8 +1642,8 @@ function kses_init_filters() {
* A quick procedural method to removing all of the filters that kses uses for * A quick procedural method to removing all of the filters that kses uses for
* content in WordPress Loop. * content in WordPress Loop.
* *
* Does not remove the kses_init() function from 'init' hook (priority is * Does not remove the kses_init() function from {@see 'init'} hook (priority is
* default). Also does not remove kses_init() function from 'set_current_user' * default). Also does not remove kses_init() function from {@see 'set_current_user'}
* hook (priority is also default). * hook (priority is also default).
* *
* @since 2.0.6 * @since 2.0.6
@ -1664,8 +1665,8 @@ function kses_remove_filters() {
/** /**
* Sets up most of the Kses filters for input form content. * Sets up most of the Kses filters for input form content.
* *
* If you remove the kses_init() function from 'init' hook and * If you remove the kses_init() function from {@see 'init'} hook and
* 'set_current_user' (priority is default), then none of the Kses filter hooks * {@see 'set_current_user'} (priority is default), then none of the Kses filter hooks
* will be added. * will be added.
* *
* First removes all of the Kses filters in case the current user does not need * First removes all of the Kses filters in case the current user does not need

4
wp-includes/link-template.php
View File

@ -32,7 +32,7 @@ function the_permalink( $post = 0 ) {
* *
* Conditionally adds a trailing slash if the permalink structure has a trailing * Conditionally adds a trailing slash if the permalink structure has a trailing
* slash, strips the trailing slash if not. The string is passed through the * slash, strips the trailing slash if not. The string is passed through the
* 'user_trailingslashit' filter. Will remove trailing slash from string, if * {@see 'user_trailingslashit'} filter. Will remove trailing slash from string, if
* site is not set to have them. * site is not set to have them.
* *
* @since 2.2.0 * @since 2.2.0
@ -3665,7 +3665,7 @@ function wp_shortlink_wp_head() {
/** /**
* Sends a Link: rel=shortlink header if a shortlink is defined for the current page. * Sends a Link: rel=shortlink header if a shortlink is defined for the current page.
* *
* Attached to the wp action. * Attached to the {@see 'wp'} action.
* *
* @since 3.0.0 * @since 3.0.0
*/ */

14
wp-includes/media.php
View File

@ -148,7 +148,7 @@ function image_hwstring( $width, $height ) {
* function won't create a new resized copy, it will just return an already * function won't create a new resized copy, it will just return an already
* resized one if it exists. * resized one if it exists.
* *
* A plugin may use the 'image_downsize' filter to hook into and offer image * A plugin may use the {@see 'image_downsize'} filter to hook into and offer image
* resizing services for images. The hook must return an array with the same * resizing services for images. The hook must return an array with the same
* elements that are returned in the function. The first element being the URL * elements that are returned in the function. The first element being the URL
* to the new image that was resized. * to the new image that was resized.
@ -309,12 +309,12 @@ function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
/** /**
* Gets an img tag for an image attachment, scaling it down if requested. * Gets an img tag for an image attachment, scaling it down if requested.
* *
* The filter 'get_image_tag_class' allows for changing the class name for the * The {@see 'get_image_tag_class'} filter allows for changing the class name for the
* image without having to use regular expressions on the HTML content. The * image without having to use regular expressions on the HTML content. The
* parameters are: what WordPress will use for the class, the Attachment ID, * parameters are: what WordPress will use for the class, the Attachment ID,
* image align value, and the size the image should be. * image align value, and the size the image should be.
* *
* The second filter 'get_image_tag' has the HTML content, which can then be * The second filter, {@see 'get_image_tag'}, has the HTML content, which can then be
* further manipulated by a plugin to change all attribute values and even HTML * further manipulated by a plugin to change all attribute values and even HTML
* content. * content.
* *
@ -562,7 +562,7 @@ function image_resize_dimensions( $orig_w, $orig_h, $dest_w, $dest_h, $crop = fa
* Resizes an image to make a thumbnail or intermediate size. * Resizes an image to make a thumbnail or intermediate size.
* *
* The returned array has the file size, the image width, and image height. The * The returned array has the file size, the image width, and image height. The
* filter 'image_make_intermediate_size' can be used to hook in and change the * {@see 'image_make_intermediate_size'} filter can be used to hook in and change the
* values of the returned array. The only parameter is the resized file path. * values of the returned array. The only parameter is the resized file path.
* *
* @since 2.5.0 * @since 2.5.0
@ -1387,8 +1387,8 @@ function wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ) {
/** /**
* Adds a 'wp-post-image' class to post thumbnails. Internal use only. * Adds a 'wp-post-image' class to post thumbnails. Internal use only.
* *
* Uses the 'begin_fetch_post_thumbnail_html' and 'end_fetch_post_thumbnail_html' action hooks to * Uses the {@see 'begin_fetch_post_thumbnail_html'} and {@see 'end_fetch_post_thumbnail_html'}
* dynamically add/remove itself so as to only filter post thumbnails. * action hooks to dynamically add/remove itself so as to only filter post thumbnails.
* *
* @ignore * @ignore
* @since 2.9.0 * @since 2.9.0
@ -1434,7 +1434,7 @@ add_shortcode('caption', 'img_caption_shortcode');
* Builds the Caption shortcode output. * Builds the Caption shortcode output.
* *
* Allows a plugin to replace the content that would otherwise be returned. The * Allows a plugin to replace the content that would otherwise be returned. The
* filter is 'img_caption_shortcode' and passes an empty string, the attr * filter is {@see 'img_caption_shortcode'} and passes an empty string, the attr
* parameter and the content parameter values. * parameter and the content parameter values.
* *
* The supported attributes for the shortcode are 'id', 'align', 'width', and * The supported attributes for the shortcode are 'id', 'align', 'width', and

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.6-alpha-37542'; $wp_version = '4.6-alpha-37543';
/** /**
* 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.