Correct @since values for various hooks. fixes #25766.

git-svn-id: https://develop.svn.wordpress.org/trunk@25991 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2013-10-30 03:19:16 +00:00
parent a1fe0926b3
commit bc6c0c9b0f
10 changed files with 46 additions and 37 deletions

View File

@ -557,7 +557,7 @@ if ( 'page' == $post_type ) {
/**
* Fires after 'normal' context meta boxes have been output for the 'page' post type.
*
* @since 1.5.2
* @since 1.5.0
*
* @param WP_Post $post Post object.
*/
@ -567,7 +567,7 @@ else {
/**
* Fires after 'normal' context meta boxes have been output for all post types other than 'page'.
*
* @since 1.5.2
* @since 1.5.0
*
* @param WP_Post $post Post object.
*/

View File

@ -247,7 +247,7 @@ add_action( 'update_option_page_on_front', 'update_home_siteurl', 10, 2 );
/**
* Shorten an URL, to be used as link text
*
* @since 1.2.1
* @since 1.2.0
*
* @param string $url
* @return string

View File

@ -252,7 +252,7 @@ class WP {
* to executing the query. Needed to allow custom rewrite rules using your own arguments
* to work, or any other custom query variables you want to be publicly available.
*
* @since 1.5.2
* @since 1.5.0
*
* @param array $public_query_vars The array of whitelisted query variables.
*/
@ -471,7 +471,7 @@ class WP {
/**
* Filter the query string before parsing.
*
* @since 1.5.2
* @since 1.5.0
* @deprecated 2.1.0 Use 'query_vars' or 'request' filters instead.
*
* @param string $query_string The query string to modify.

View File

@ -34,7 +34,7 @@ function get_comment_author( $comment_ID = 0 ) {
/**
* Filter the returned comment author name.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string $author The comment author's username.
*/
@ -53,7 +53,7 @@ function comment_author( $comment_ID = 0 ) {
/**
* Filter the comment author's name for display.
*
* @since 1.2.1
* @since 1.2.0
*
* @param string $author The comment author's username.
*/
@ -74,7 +74,7 @@ function get_comment_author_email( $comment_ID = 0 ) {
/**
* Filter the comment author's returned email address.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string $comment->comment_author_email The comment author's email address.
*/
@ -99,7 +99,7 @@ function comment_author_email( $comment_ID = 0 ) {
/**
* Filter the comment author's email for display.
*
* @since 1.2.1
* @since 1.2.0
*
* @param string $author_email The comment author's email address.
*/
@ -153,7 +153,7 @@ function get_comment_author_email_link( $linktext = '', $before = '', $after = '
* Care should be taken to protect the email address and assure that email
* harvesters do not capture your commentors' email address.
*
* @since 1.2.1
* @since 1.2.0
*
* @param string $comment->comment_author_email The comment author's email address.
*/
@ -192,7 +192,7 @@ function get_comment_author_link( $comment_ID = 0 ) {
/**
* Filter the comment author's link for display.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string $return The HTML-formatted comment author link. Empty for an invalid URL.
*/
@ -225,7 +225,7 @@ function get_comment_author_IP( $comment_ID = 0 ) {
/**
* Filter the comment author's returned IP address.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string $comment->comment_author_IP The comment author's IP address.
*/
@ -255,7 +255,14 @@ function get_comment_author_url( $comment_ID = 0 ) {
$comment = get_comment( $comment_ID );
$url = ('http://' == $comment->comment_author_url) ? '' : $comment->comment_author_url;
$url = esc_url( $url, array('http', 'https') );
return apply_filters('get_comment_author_url', $url);
/**
* Filter the comment author's URL.
*
* @since 1.5.0
*
* @param string $url The comment author's URL.
*/
return apply_filters( 'get_comment_author_url', $url );
}
/**
@ -270,7 +277,7 @@ function comment_author_url( $comment_ID = 0 ) {
/**
* Filter the comment author's URL for display.
*
* @since 1.2.1
* @since 1.2.0
*
* @param string $author_url The comment author's URL.
*/
@ -306,7 +313,7 @@ function get_comment_author_url_link( $linktext = '', $before = '', $after = ''
/**
* Filter the comment author's returned URL link.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string $return The HTML-formatted comment author URL link.
*/
@ -445,7 +452,7 @@ function get_comment_date( $d = '', $comment_ID = 0 ) {
/**
* Filter the returned comment date.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string|int $date Formatted date string or Unix timestamp.
* @param string $d The format of the date.
@ -508,7 +515,7 @@ function comment_excerpt( $comment_ID = 0 ) {
/**
* Filter the comment excerpt for display.
*
* @since 1.2.1
* @since 1.2.0
*
* @param string $comment_excerpt The comment excerpt text.
*/
@ -527,7 +534,7 @@ function get_comment_ID() {
/**
* Filter the returned comment ID.
*
* @since 1.5.2
* @since 1.5.0
*
* @param int $comment->comment_ID The current comment ID.
*/
@ -660,7 +667,7 @@ function get_comments_number( $post_id = 0 ) {
/**
* Filter the returned comment count for a post.
*
* @since 1.5.2
* @since 1.5.0
*
* @param int $count The number of comments a post has.
* @param int|WP_Post $post_id The post ID or WP_Post object.
@ -694,7 +701,7 @@ function comments_number( $zero = false, $one = false, $more = false, $deprecate
/**
* Filter the comments count for display.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string $output A translatable string formatted based on whether the count is equal to 0, 1, or 1+. @see _n()
* @param int $number The number of post comments.
@ -717,7 +724,7 @@ function get_comment_text( $comment_ID = 0, $args = array() ) {
/**
* Filter the text of a comment.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string $comment->comment_content The text of the comment.
* @param object $comment The comment object.
@ -743,7 +750,7 @@ function comment_text( $comment_ID = 0, $args = array() ) {
/**
* Filter the text of a comment to be displayed.
*
* @since 1.2.1
* @since 1.2.0
*
* @param string $comment_text The text of the current comment.
* @param object $comment The comment object.
@ -773,7 +780,7 @@ function get_comment_time( $d = '', $gmt = false, $translate = true ) {
/**
* Filter the returned comment time.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string|int $date The comment time, formatted as a date string or Unix timestamp.
* @param string $d The date format.
@ -810,7 +817,7 @@ function get_comment_type( $comment_ID = 0 ) {
/**
* Filter the returned comment type.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string $comment->comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
*/
@ -1081,7 +1088,7 @@ function comments_template( $file = '/comments.php', $separate_comments = false
/**
* Filter the path to the theme template file used for the comments template.
*
* @since 1.5.2
* @since 1.5.1
*
* @param string $theme_template The path to the theme template file.
*/
@ -2101,7 +2108,7 @@ function comment_form( $args = array(), $post_id = null ) {
/**
* Fires at the bottom of the comment form, inside the closing </form> tag.
*
* @since 1.5.2
* @since 1.5.0
*
* @param int $post_id The post ID.
*/

View File

@ -30,7 +30,7 @@ function get_locale() {
/**
* Filter WordPress install's locale ID.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string $locale The locale ID.
*/

View File

@ -66,6 +66,8 @@ function wp_get_active_network_plugins() {
* use the wp-content/blog-deleted.php, blog-inactive.php and
* blog-suspended.php drop-ins.
*
* @since 3.0.0
*
* @return bool|string Returns true on success, or drop-in file to include.
*/
function ms_site_check() {
@ -76,7 +78,7 @@ function ms_site_check() {
/**
* Filter checking the status of the current blog.
*
* @since 1.2.1
* @since 3.0.0
*
* @param bool null Whether to skip the blog status check. Default null.
*/

View File

@ -7,7 +7,7 @@ if ( defined('WP_USE_THEMES') && WP_USE_THEMES )
/**
* Fires before determining which template to load.
*
* @since 1.5.2
* @since 1.5.0
*/
do_action( 'template_redirect' );

View File

@ -34,7 +34,7 @@ function get_query_template( $type, $templates = array() ) {
* -- 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.2
* @since 1.5.0
*
* @param string $template Path to the template. @see locate_template()
*/

View File

@ -299,8 +299,8 @@ function retrieve_password() {
/**
* Fires before a new password is retrieved.
*
* @since 1.5.2
* @deprecated 1.5.2 Misspelled. Use 'retrieve_password' hook instead.
* @since 1.5.0
* @deprecated 1.5.1 Misspelled. Use 'retrieve_password' hook instead.
*
* @param string $user_login The user login name.
*/
@ -308,7 +308,7 @@ function retrieve_password() {
/**
* Fires before a new password is retrieved.
*
* @since 1.5.2
* @since 1.5.1
*
* @param string $user_login The user login name.
*/
@ -508,7 +508,7 @@ case 'retrievepassword' :
/**
* Fires before the lost password form.
*
* @since 1.5.2
* @since 1.5.1
*/
do_action( 'lost_password' );
@ -542,7 +542,7 @@ if ( get_option( 'users_can_register' ) ) :
/**
* Filter the registration URL below the login form.
*
* @since 1.5.2
* @since 1.5.0
*
* @param string $registration_url Registration URL.
*/

View File

@ -219,7 +219,7 @@ if ( WP_CACHE && function_exists( 'wp_cache_postload' ) )
*
* Pluggable functions are also available at this point in the loading order.
*
* @since 1.5.2
* @since 1.5.0
*/
do_action( 'plugins_loaded' );
@ -335,7 +335,7 @@ $wp->init();
*
* If you wish to plug an action once WP is loaded, use the wp_loaded hook below.
*
* @since 1.5.2
* @since 1.5.0
*/
do_action( 'init' );