Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-31 13:37:51 +01:00
Code Issues Projects Releases Wiki Activity

Docs: Corrections relating to types used in inline documentation for comment ID and site ID proprties.

Browse Source 
Includes a correction for a typo introduced in [52204].

See #53399

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


git-svn-id: http://core.svn.wordpress.org/trunk@51797 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2021-11-18 13:57:01 +00:00
parent c9746ab584
commit 40626108d0
10 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-admin/includes/class-wp-comments-list-table.php
View File

@ -1072,7 +1072,7 @@ class WP_Comments_List_Table extends WP_List_Table {
* @since 2.8.0
*
* @param string $column_name The custom column's name.
* @param int $comment_id The custom column's unique ID number.
* @param string $comment_id The comment ID as a numeric string.
*/
do_action( 'manage_comments_custom_column', $column_name, $item->comment_ID );
}

4
wp-admin/network/sites.php
View File

@ -261,7 +261,7 @@ if ( isset( $_GET['action'] ) ) {
*
* @since MU (3.0.0)
*
* @param string $id The ID of the activated site.
* @param int $id The ID of the activated site.
*/
do_action( 'activate_blog', $id );
break;
@ -272,7 +272,7 @@ if ( isset( $_GET['action'] ) ) {
*
* @since MU (3.0.0)
*
* @param string $id The ID of the site being deactivated.
* @param int $id The ID of the site being deactivated.
*/
do_action( 'deactivate_blog', $id );

34
wp-includes/comment-template.php
View File

@ -42,7 +42,7 @@ function get_comment_author( $comment_ID = 0 ) {
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
* @param string $author The comment author's username.
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
* @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_author', $author, $comment->comment_ID, $comment );
@ -68,7 +68,7 @@ function comment_author( $comment_ID = 0 ) {
* @since 4.1.0 The `$comment_ID` parameter was added.
*
* @param string $author The comment author's username.
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
*/
echo apply_filters( 'comment_author', $author, $comment->comment_ID );
}
@ -93,7 +93,7 @@ function get_comment_author_email( $comment_ID = 0 ) {
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
* @param string $comment_author_email The comment author's email address.
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
* @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_author_email', $comment->comment_author_email, $comment->comment_ID, $comment );
@ -125,7 +125,7 @@ function comment_author_email( $comment_ID = 0 ) {
* @since 4.1.0 The `$comment_ID` parameter was added.
*
* @param string $author_email The comment author's email address.
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
*/
echo apply_filters( 'author_email', $author_email, $comment->comment_ID );
}
@ -236,7 +236,7 @@ function get_comment_author_link( $comment_ID = 0 ) {
* @param string $return The HTML-formatted comment author link.
* Empty for an invalid URL.
* @param string $author The comment author's username.
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
*/
return apply_filters( 'get_comment_author_link', $return, $author, $comment->comment_ID );
}
@ -274,7 +274,7 @@ function get_comment_author_IP( $comment_ID = 0 ) { // phpcs:ignore WordPress.Na
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
* @param string $comment_author_IP The comment author's IP address, or an empty string if it's not available.
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
* @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_author_IP', $comment->comment_author_IP, $comment->comment_ID, $comment ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase
@ -320,9 +320,9 @@ function get_comment_author_url( $comment_ID = 0 ) {
* @since 1.5.0
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
* @param string $url The comment author's URL.
* @param int $comment_ID The comment ID.
* @param WP_Comment $comment The comment object.
* @param string $url The comment author's URL, or an empty string.
* @param string|int $comment_ID The comment ID as a numeric string, or 0 if not found.
* @param WP_Comment|null $comment The comment object, or null if not found.
*/
return apply_filters( 'get_comment_author_url', $url, $id, $comment );
}
@ -347,7 +347,7 @@ function comment_author_url( $comment_ID = 0 ) {
* @since 4.1.0 The `$comment_ID` parameter was added.
*
* @param string $author_url The comment author's URL.
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
*/
echo apply_filters( 'comment_url', $author_url, $comment->comment_ID );
}
@ -531,7 +531,7 @@ function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
*
* @param string[] $classes An array of comment classes.
* @param string[] $class An array of additional classes added to the list.
* @param int $comment_id The comment ID.
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The comment object.
* @param int|WP_Post $post_id The post ID or WP_Post object.
*/
@ -624,7 +624,7 @@ function get_comment_excerpt( $comment_ID = 0 ) {
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
* @param string $excerpt The comment excerpt text.
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
* @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_excerpt', $excerpt, $comment->comment_ID, $comment );
@ -650,7 +650,7 @@ function comment_excerpt( $comment_ID = 0 ) {
* @since 4.1.0 The `$comment_ID` parameter was added.
*
* @param string $comment_excerpt The comment excerpt text.
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
*/
echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment->comment_ID );
}
@ -660,7 +660,7 @@ function comment_excerpt( $comment_ID = 0 ) {
*
* @since 1.5.0
*
* @return int The comment ID.
* @return string The comment ID as a numeric string.
*/
function get_comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
$comment = get_comment();
@ -669,9 +669,9 @@ function get_comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFun
* Filters the returned comment ID.
*
* @since 1.5.0
* @since 4.1.0 The `$comment_ID` parameter was added.
* @since 4.1.0 The `$comment` parameter was added.
*
* @param int $comment_ID The current comment ID.
* @param string $comment_ID The current comment ID as a numeric string.
* @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_ID', $comment->comment_ID, $comment ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase
@ -1097,7 +1097,7 @@ function get_comment_type( $comment_ID = 0 ) {
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
* @param string $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
* @param WP_Comment $comment The comment object.
*/
return apply_filters( 'get_comment_type', $comment->comment_type, $comment->comment_ID, $comment );

20
wp-includes/comment.php
View File

@ -1488,7 +1488,7 @@ function wp_delete_comment( $comment_id, $force_delete = false ) {
* @since 1.2.0
* @since 4.9.0 Added the `$comment` parameter.
*
* @param int $comment_id The comment ID.
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The comment to be deleted.
*/
do_action( 'delete_comment', $comment->comment_ID, $comment );
@ -1516,7 +1516,7 @@ function wp_delete_comment( $comment_id, $force_delete = false ) {
* @since 2.9.0
* @since 4.9.0 Added the `$comment` parameter.
*
* @param int $comment_id The comment ID.
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The deleted comment.
*/
do_action( 'deleted_comment', $comment->comment_ID, $comment );
@ -1562,7 +1562,7 @@ function wp_trash_comment( $comment_id ) {
* @since 2.9.0
* @since 4.9.0 Added the `$comment` parameter.
*
* @param int $comment_id The comment ID.
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The comment to be trashed.
*/
do_action( 'trash_comment', $comment->comment_ID, $comment );
@ -1579,7 +1579,7 @@ function wp_trash_comment( $comment_id ) {
* @since 2.9.0
* @since 4.9.0 Added the `$comment` parameter.
*
* @param int $comment_id The comment ID.
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The trashed comment.
*/
do_action( 'trashed_comment', $comment->comment_ID, $comment );
@ -1610,7 +1610,7 @@ function wp_untrash_comment( $comment_id ) {
* @since 2.9.0
* @since 4.9.0 Added the `$comment` parameter.
*
* @param int $comment_id The comment ID.
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The comment to be untrashed.
*/
do_action( 'untrash_comment', $comment->comment_ID, $comment );
@ -1630,7 +1630,7 @@ function wp_untrash_comment( $comment_id ) {
* @since 2.9.0
* @since 4.9.0 Added the `$comment` parameter.
*
* @param int $comment_id The comment ID.
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The untrashed comment.
*/
do_action( 'untrashed_comment', $comment->comment_ID, $comment );
@ -1709,7 +1709,7 @@ function wp_unspam_comment( $comment_id ) {
* @since 2.9.0
* @since 4.9.0 Added the `$comment` parameter.
*
* @param int $comment_id The comment ID.
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The comment to be unmarked as spam.
*/
do_action( 'unspam_comment', $comment->comment_ID, $comment );
@ -1729,7 +1729,7 @@ function wp_unspam_comment( $comment_id ) {
* @since 2.9.0
* @since 4.9.0 Added the `$comment` parameter.
*
* @param int $comment_id The comment ID.
* @param string $comment_id The comment ID as a numeric string.
* @param WP_Comment $comment The comment unmarked as spam.
*/
do_action( 'unspammed_comment', $comment->comment_ID, $comment );
@ -1863,7 +1863,7 @@ function wp_transition_comment_status( $new_status, $old_status, $comment ) {
*
* @since 2.7.0
*
* @param int $comment_ID The comment ID.
* @param string $comment_ID The comment ID as a numeric string.
* @param WP_Comment $comment Comment object.
*/
do_action( "comment_{$new_status}_{$comment->comment_type}", $comment->comment_ID, $comment );
@ -2433,7 +2433,7 @@ function wp_set_comment_status( $comment_id, $comment_status, $wp_error = false
*
* @since 1.5.0
*
* @param int $comment_id Comment ID.
* @param string $comment_id Comment ID as a numeric string.
* @param string $comment_status Current comment status. Possible values include
* 'hold', '0', 'approve', '1', 'spam', and 'trash'.
*/

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

@ -1628,7 +1628,7 @@ function edit_comment_link( $text = null, $before = '', $after = '' ) {
* @since 2.3.0
*
* @param string $link Anchor tag for the edit link.
* @param int $comment_id Comment ID.
* @param string $comment_id Comment ID as a numeric string.
* @param string $text Anchor text.
*/
echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID, $text ) . $after;

4
wp-includes/ms-functions.php
View File

@ -1469,8 +1469,8 @@ Disable these notifications: %4$s'
* @since MU (3.0.0)
* @since 5.4.0 The `$blog_id` parameter was added.
*
* @param string $msg Email body.
* @param int $blog_id The new site's ID.
* @param string $msg Email body.
* @param int|string $blog_id The new site's ID as an integer or numeric string.
*/
$msg = apply_filters( 'newblog_notify_siteadmin', $msg, $blog_id );

2
wp-includes/ms-site.php
View File

@ -977,7 +977,7 @@ function clean_blog_cache( $blog ) {
*
* @since 4.6.0
*
* @param int $id Blog ID.
* @param string $id Site ID as a numeric string.
* @param WP_Site $blog Site object.
* @param string $domain_path_key md5 hash of domain and path.
*/

14
wp-includes/pluggable.php
View File

@ -1584,7 +1584,7 @@ if ( ! function_exists( 'wp_notify_postauthor' ) ) :
* @since 3.7.0
*
* @param string[] $emails An array of email addresses to receive a comment notification.
* @param int $comment_id The comment ID.
* @param string $comment_id The comment ID as a numeric string.
*/
$emails = apply_filters( 'comment_notification_recipients', $emails, $comment->comment_ID );
$emails = array_filter( $emails );
@ -1605,9 +1605,9 @@ if ( ! function_exists( 'wp_notify_postauthor' ) ) :
*
* @since 3.8.0
*
* @param bool $notify Whether to notify the post author of their own comment.
* Default false.
* @param int $comment_id The comment ID.
* @param bool $notify Whether to notify the post author of their own comment.
* Default false.
* @param string $comment_id The comment ID as a numeric string.
*/
$notify_author = apply_filters( 'comment_notification_notify_author', false, $comment->comment_ID );
@ -1740,7 +1740,7 @@ if ( ! function_exists( 'wp_notify_postauthor' ) ) :
* @since 1.5.2
*
* @param string $notify_message The comment notification email text.
* @param int $comment_id Comment ID.
* @param string $comment_id Comment ID as a numeric string.
*/
$notify_message = apply_filters( 'comment_notification_text', $notify_message, $comment->comment_ID );
@ -1750,7 +1750,7 @@ if ( ! function_exists( 'wp_notify_postauthor' ) ) :
* @since 1.5.2
*
* @param string $subject The comment notification email subject.
* @param int $comment_id Comment ID.
* @param string $comment_id Comment ID as a numeric string.
*/
$subject = apply_filters( 'comment_notification_subject', $subject, $comment->comment_ID );
@ -1760,7 +1760,7 @@ if ( ! function_exists( 'wp_notify_postauthor' ) ) :
* @since 1.5.2
*
* @param string $message_headers Headers for the comment notification email.
* @param int $comment_id Comment ID.
* @param string $comment_id Comment ID as a numeric string.
*/
$message_headers = apply_filters( 'comment_notification_headers', $message_headers, $comment->comment_ID );

2
wp-includes/rest-api/endpoints/class-wp-rest-block-navigation-areas-controller.php
View File

@ -246,7 +246,7 @@ class WP_REST_Block_Navigation_Areas_Controller extends WP_REST_Controller {
* Allows modification of the navigation area data right before it is
* returned.
*
* @param WP_REST_Response\WP_Error $response The response object, or WP_Error object on failure.
* @param WP_REST_Response|WP_Error $response The response object, or WP_Error object on failure.
* @param object $area The original status object.
* @param WP_REST_Request $request Request used to generate the response.
*/

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.9-alpha-52204';
$wp_version = '5.9-alpha-52205';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.