Docs: Descriptive improvements and corrections for various docblocks.

See #53399

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


git-svn-id: http://core.svn.wordpress.org/trunk@50909 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn
2021-07-01 21:12:58 +00:00
parent 9146628ae1
commit ea60cd8191
19 changed files with 123 additions and 80 deletions

View File

@@ -262,7 +262,7 @@ function comment_author_link( $comment_ID = 0 ) {
*
* @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's IP address.
* Default current comment.
* @return string Comment author's IP address.
* @return string Comment author's IP address, or an empty string if it's not available.
*/
function get_comment_author_IP( $comment_ID = 0 ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
$comment = get_comment( $comment_ID );
@@ -273,7 +273,7 @@ function get_comment_author_IP( $comment_ID = 0 ) { // phpcs:ignore WordPress.Na
* @since 1.5.0
* @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
*
* @param string $comment_author_IP The comment author's IP address.
* @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 WP_Comment $comment The comment object.
*/