get_comment_author_link( int|WP_Comment $comment_id = 0 ): string

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$comment_idint|WP_Commentoptional

WP_Comment or the ID of the comment for which to get the author's link.
Default current comment.Default: 0

Return value

string

The comment author name or HTML link for author's URL.

Performance profile

How much work a call to get_comment_author_link() 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

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

29–62

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 69.

Plugin surface

2 hooks

Third-party callbacks on 'comment_author_link_rel', 'get_comment_author_link' run inside this call, and their cost is not bounded by anything here.

Called by

8

8 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_comment_author_link() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while get_comment_author_link() runs, in this order:

1. 1
   apply_filters( comment_author_link_rel )filterline 267 (+34 into the body)

   Filters the rel attributes of the comment author's link.

2. 2
   apply_filters( get_comment_author_link )filterline 293 (+60 into the body)

   Filters the comment author's link for display.

Uses · 6

• get_comment()Retrieves comment data given a comment ID or comment object.
• get_comment_author_url()Retrieves the URL of the author of the current comment, not linked.
• get_comment_author()Retrieves the author of the current comment.
• wp_is_internal_link()Determines whether or not the specified URL is of a host included in the internal hosts list.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• esc_attr()Escaping for HTML attributes.

Used by · 8

• WP_Widget_Recent_Comments::widget()Outputs the content for the current Recent Comments widget instance.
• Walker_Comment::comment()Outputs a single comment.
• Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
• _wp_dashboard_recent_comments_row()Outputs a row for the Recent Comments widget.
• comment_author_link()Displays the HTML link to the URL of the author of the current comment.
• twentyeleven_comment()Template for comments and pingbacks.
• twentyten_comment()Template for comments and pingbacks.
• twentytwelve_comment()Template for comments and pingbacks.

Source code

View on Trac ↗View on GitHub ↗

233function get_comment_author_link( $comment_id = 0 ) {234	$comment = get_comment( $comment_id );235 236	if ( ! empty( $comment->comment_ID ) ) {237		$comment_id = $comment->comment_ID;238	} elseif ( is_scalar( $comment_id ) ) {239		$comment_id = (string) $comment_id;240	} else {241		$comment_id = '0';242	}243 244	$comment_author_url = get_comment_author_url( $comment );245	$comment_author     = get_comment_author( $comment );246 247	if ( empty( $comment_author_url ) || 'http://' === $comment_author_url ) {248		$comment_author_link = $comment_author;249	} else {250		$rel_parts = array( 'ugc' );251		if ( ! wp_is_internal_link( $comment_author_url ) ) {252			$rel_parts = array_merge(253				$rel_parts,254				array( 'external', 'nofollow' )255			);256		}257 258		/**259		 * Filters the rel attributes of the comment author's link.260		 *261		 * @since 6.2.0262		 *263		 * @param string[]   $rel_parts An array of strings representing the rel tags264		 *                              which will be joined into the anchor's rel attribute.265		 * @param WP_Comment $comment   The comment object.266		 */267		$rel_parts = apply_filters( 'comment_author_link_rel', $rel_parts, $comment );268 269		$rel = implode( ' ', $rel_parts );270		$rel = esc_attr( $rel );271		// Empty space before 'rel' is necessary for later sprintf().272		$rel = ! empty( $rel ) ? sprintf( ' rel="%s"', $rel ) : '';273 274		$comment_author_link = sprintf(275			'<a href="%1$s" class="url"%2$s>%3$s</a>',276			$comment_author_url,277			$rel,278			$comment_author279		);280	}281 282	/**283	 * Filters the comment author's link for display.284	 *285	 * @since 1.5.0286	 * @since 4.1.0 The `$comment_author` and `$comment_id` parameters were added.287	 *288	 * @param string $comment_author_link The HTML-formatted comment author link.289	 *                                    Empty for an invalid URL.290	 * @param string $comment_author      The comment author's username.291	 * @param string $comment_id          The comment ID as a numeric string.292	 */293	return apply_filters( 'get_comment_author_link', $comment_author_link, $comment_author, $comment_id );294}

Changelog

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/comment-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.