Introduce comment excerpt length filter

[dannydehaan]

Hi,

I needed this for a client. I could have created a new function in my functions.php file, but why don't create a filter so it's much simpler to set the length for the comment excerpt.

I've also fixed some strange names in the functions like $blah and use_dotdotdot.

[dannydehaan]

Fix for 27526

[nacin]

Looks good. If we're going to fix spacing, we should add spaces to $i<$k as well.

This will need hook documentation. Also, I'd probably keep "20" in the main function docs, as it's the default.

[DrewAPicture]

See existing hook documentation in core for reference, as well as the ​inline documentation standards for hooks.

[dannydehaan]

27526-2 - Extra spacing in for loop

[dannydehaan]

Added a new diff. Now with the correct spacing. Thanks @nacin

[dannydehaan]

27526-3 - Added inline doc

[dannydehaan]

@DrewAPicture
Sorry, i didn't mentioned your comment. Fixed this now. Thanks!

[dannydehaan]

@nacin,

I did found out, that when your comment is like the default comment from Mr. WordPress, the excerpt length will be 21 words. This is because of the "\n" or "\r" that is in the comment. I've fixed this by replacing the \n \r characters for a space. I've also found an issue when the ellipsis are used, the comment excerpt will look like this:

---

Hi, this is a comment. To delete a comment, just log in and view the post's comments. There you will …

---

Notice the space between will and … I've fixed this now by imploding the words with a space so you will not have this behaviour.

[dannydehaan]

27526-2 - Fix in excerpt length with \n or \r. Fix for "trailing space"

[SergeyBiryukov]

Replying to dannydehaan:

Notice the space between will and … I've fixed this now by imploding the words with a space so you will not have this behaviour.

We can just use trim() before adding the ellipsis (like we did for wp_html_excerpt() in [24214]).

[SergeyBiryukov]

@since should use the 3-digit x.x.x style, 3.9.0 in this case.

[dannydehaan]

27526-5 - Trim excerpt before adding ellipsis. Correct @since

[dannydehaan]

Hi Sergey,

Thank you for your feedback. I've edited the patch like you said.

[wonderboymusic]

In 34520:

Comments: add a 'comment_excerpt_length' filter to get_comment_excerpt().

Create the first ever unit tests for get_comment_excerpt().

Props dannydehaan, wonderboymusic.
Fixes #27526.