#1: pre_comment_author_name

The pre_comment_author_name filter allows you to modify a comment author’s name before the comment is created or updated.

It’s evaluated in:

The value of pre_comment_author_name is also filtered through:

sanitize_text_field
and wp_filter_kses
and _wp_specialchars on priority 30 in wp-includes/default-filters.php

Example:

Let’s say you want to prefix commenters’ names with the word ‘Admin’ if they are administrators on your site. The following example will turn ‘Some Name’ into ‘Admin: Some Name’.

We’ll use the manage_options capability to determine if the commenter is an admin, and if so, filter the name. If they don’t have the capability (aren’t an admin), we’ll return the name unfiltered.

Have a suggested improvement? You can fork the Gist and comment back with the link. If all is agreeable, I’ll merge in your changes. Crowd-sourced documentation FTW!

10 thoughts on “#1: pre_comment_author_name”

I feel like we could literally check the user role slug here since we’re displaying something indicating someone’s role, not what capability they have.

Perhaps embedded gists would allow for easier collaboration on code examples though? On the other hand, owning data and all…

Drew Jaynes says:

July 16, 2013 at 4:29 pm

Feel free to fork the gist and post back with the URL if you have a suggested improvement.

Reply

It would probably be better to do a sprintf() for translations, since word order might be different. So, sprintf( __( ‘Admin: %s ‘, ‘yourtextdomain’ ), $name ).