comment_text filter is passed inconsistent arguments

[danielbachhuber]

Only one argument is supplied in check_comment():

/** This filter is documented in wp-includes/comment-template.php */
$comment = apply_filters( 'comment_text', $comment );

However, three arguments are supplied in comment_text():

echo apply_filters( 'comment_text', $comment_text, $comment, $args );

The former should probably have two null values passed so error notices aren't triggered in callbacks hooking into the latter.

[boonebgorges]

Timeline, for reference:

• [15957] $comment arg added to filter in comment_text()
• [16357] 'comment_text' filter introduced in check_comment(). At this point, the two uses of the filter have already diverged
• [25555] added the $args param to the filter in comment_text()

Passing null values in check_comment() would prevent against certain kinds of errors, but it also makes the filter documentation incorrect. @DrewAPicture do you have a suggestion for how to document this kind of problem? Can we say, eg,

 * @param null|WP_Comment $comment Comment object, if available. 

[DrewAPicture]

@boonebgorges I think we'd be fine adding the null type for parameter notations, sure.

[boonebgorges]

Thanks, @DrewAPicture !

Patch will need to include documentation to this effect.

[vaishu.agola27]

Changed Documentation of 'comment_text' filter and passed null values in check_comment()

[SergeyBiryukov]

#24913 was marked as a duplicate.

[SergeyBiryukov]

Let's pass an empty array instead of null for $args, see comment:6:ticket:24913.

[vaishu.agola27]

empty array passed instead of null in $args

[rachelbaker]

In 40664:

Comments: Update arguments passed to the 'comment_text' filter in check_comment().

Pass null or empty values for the missing $comment and $args parameters of the 'check_comment' filter in check_comment().

Props boonebgorges, vaishu.agola27, SergeyBiryukov.
Fixes #38314.