is_avatar_comment_type( string $comment_type ): bool
- Since
- 5.1.0
- Source
wp-includes/link-template.php:4338
Compatibility
- WordPress
- since 5.1.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$comment_typestring- Comment type to check.
Return value
bool- Whether the comment type is allowed for retrieving avatars.
Performance profile
How much work a call to is_avatar_comment_type() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 10
- Plugin surface
- 1 hook
- Called by
- 1
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 10.
Third-party callbacks on 'get_avatar_comment_types' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost is_avatar_comment_type() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 10 | apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 10 | 10 | 0 | |
| 8.5 | 10 | 10 | 0 | |
| 8.4 | 10 | 10 | 0 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 13 | 13 | 0 | |
| 8.2 | 13 | 13 | 0 | |
| 8.1 | 13 | 13 | 0 | |
| 7.4 | 13 | 13 | 0 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while is_avatar_comment_type() runs, in this order:
- apply_filters( get_avatar_comment_types )filterline 4346 (+8 into the body)
Filters the list of allowed comment types for retrieving avatars.
Uses · 1
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 1
- get_avatar_data()Retrieves default data about the avatar.
Source code
function is_avatar_comment_type( $comment_type ) { /** * Filters the list of allowed comment types for retrieving avatars. * * @since 3.0.0 * * @param array $types An array of content types. Default only contains 'comment'. */ $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) ); return in_array( $comment_type, (array) $allowed_comment_types, true );}Changelog
Introduced in 5.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.7.7 tag, from
src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.