Add an $args parameter to comment_text filter

[simonwheatley]

When using the comment_text filter, there are times when the context provided by $args would be extremely useful. For example to know the depth of the commen. I propose adding an additional parameter for comment_text to add the $args.

I've incorporated the proposed $comment_ID parameter from #14261, which looks to add a $comment_id parameter to the same filter, in the hope that this is helpful... let me know if not and I'll refactor.

I've included a small plugin to demo the use and prove the new parameters are working, and the diff for a small tweak to Twenty Ten v1.1 which is needed to use this plugin with that theme.

[simonwheatley]

Small test plugin

[hakre]

Related: #14681

---

some feedback:

• comment_text args param.diff contains a debug line: error_log( ... ).

• instead of passing $args (which looks okay to me so far, could not completely dig into there), another idea might be to pass the $comment object to the filter as well as it is done with posts.

[simonwheatley]

Now with less error_log calls

[dd32]

Extra context for filters++;

[scribu]

I'm getting a "malformed patch" error.

[jorbin]

I refreshed the patch. It should apply cleanly now.

[jorbin]

refresh (without trailing whitespace this time)

[hakre]

Just a small thing: in function comment_text() the new args argument is not optional. And can you make $args default values array() instead of NULL for both functions?

[wonderboymusic]

Refreshed against trunk

[ericlewis]

14856.1.diff​ refreshes for 23694

[DrewAPicture]

14856.2.diff​ fixes a typo in the Walker_Comment::comment() change and clarifies the docblock changes.

The passed args work as expected with the filters.

[wonderboymusic]

@DrewAPicture - please review this again

[DrewAPicture]

docs review + filter docs

[DrewAPicture]

Replying to wonderboymusic:

@DrewAPicture - please review this again

14856.3.diff​ refreshes the inline docs per standards and adds filter docs for the get_comment_text and comment_text filters.

[DrewAPicture]

Add defaults to the functional docs.

[DrewAPicture]

14856.4.diff​ adds defaults to the functional docs.

[wonderboymusic]

In 25555:

Add an $args parameter to comment_text and get_comment_text filters. Adds filter docs. Improve docblocks for get_comment_text() and comment_text().

Props simonwheatley, ericlewis, DrewAPicture.
Fixes #14856.