render_block_core_avatar( array $attributes, string $content, WP_Block $block ): string

Compatibility

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

Parameters

$attributesarray

Block attributes.

$contentstring

Block default content.

$blockWP_Block

Block instance.

Return value

string

Return the avatar.

Performance profile

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

Heavy

Reaches the database via get_post().

Scaling

Constant

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

Instructions

31–120

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()one call below render_block_core_avatar()
• querycontent queryget_post()one call below render_block_core_avatar()
• optionoption read or writeget_option()one call below render_block_core_avatar()

Further down the call graph this can also reach 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 · 32 distinct outcomes

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

Uses · 11

• get_block_wrapper_attributes()Generates a string of attributes by applying to the current block being rendered all of the features that the block supports.
• get_block_core_avatar_border_attributes()Generates class names and styles to apply the border support styles for the Avatar block.
• esc_attr()Escaping for HTML attributes.
• get_post_field()Retrieves data from a post field based on Post ID.
• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• get_the_author_meta()Retrieves the requested data of the author of the current post.
• __()Retrieves the translation of $text.
• get_avatar()Retrieves the avatar `` tag for a user, email address, MD5 hash, comment, or post.
• esc_url()Checks and cleans a URL.
• get_author_posts_url()Retrieves the URL to the author page for the user with the ID provided.
• get_comment()Retrieves comment data given a comment ID or comment object.

Source code

View on Trac ↗View on GitHub ↗

18function render_block_core_avatar( $attributes, $content, $block ) {19	$size               = $attributes['size'] ?? 96;20	$wrapper_attributes = get_block_wrapper_attributes();21	$border_attributes  = get_block_core_avatar_border_attributes( $attributes );22 23	// Class gets passed through `esc_attr` via `get_avatar`.24	$image_classes = ! empty( $border_attributes['class'] )25		? "wp-block-avatar__image {$border_attributes['class']}"26		: 'wp-block-avatar__image';27 28	// Unlike class, `get_avatar` doesn't filter the styles via `esc_attr`.29	// The style engine does pass the border styles through30	// `safecss_filter_attr` however.31	$image_styles = ! empty( $border_attributes['style'] )32		? sprintf( ' style="%s"', esc_attr( $border_attributes['style'] ) )33		: '';34 35	if ( ! isset( $block->context['commentId'] ) ) {36		if ( isset( $attributes['userId'] ) ) {37			$author_id = $attributes['userId'];38		} elseif ( isset( $block->context['postId'] ) ) {39			$author_id = get_post_field( 'post_author', $block->context['postId'] );40		} else {41			$author_id = get_query_var( 'author' );42		}43 44		if ( empty( $author_id ) ) {45			return '';46		}47 48		$author_name = get_the_author_meta( 'display_name', $author_id );49		// translators: %s: Author name.50		$alt          = sprintf( __( '%s Avatar' ), $author_name );51		$avatar_block = get_avatar(52			$author_id,53			$size,54			'',55			$alt,56			array(57				'extra_attr' => $image_styles,58				'class'      => $image_classes,59			)60		);61		if ( isset( $attributes['isLink'] ) && $attributes['isLink'] ) {62			$label = '';63			if ( '_blank' === $attributes['linkTarget'] ) {64				// translators: %s is the Author name.65				$label = 'aria-label="' . esc_attr( sprintf( __( '(%s author archive, opens in a new tab)' ), $author_name ) ) . '"';66			}67			// translators: 1: Author archive link. 2: Link target. %3$s Aria label. %4$s Avatar image.68			$avatar_block = sprintf( '<a href="%1$s" target="%2$s" %3$s class="wp-block-avatar__link">%4$s</a>', esc_url( get_author_posts_url( $author_id ) ), esc_attr( $attributes['linkTarget'] ), $label, $avatar_block );69		}70		return sprintf( '<div %1$s>%2$s</div>', $wrapper_attributes, $avatar_block );71	}72	$comment = get_comment( $block->context['commentId'] );73	if ( ! $comment ) {74		return '';75	}76	/* translators: %s: Author name. */77	$alt          = sprintf( __( '%s Avatar' ), $comment->comment_author );78	$avatar_block = get_avatar(79		$comment,80		$size,81		'',82		$alt,83		array(84			'extra_attr' => $image_styles,85			'class'      => $image_classes,86		)87	);88	if ( isset( $attributes['isLink'] ) && $attributes['isLink'] && isset( $comment->comment_author_url ) && '' !== $comment->comment_author_url ) {89		$label = '';90		if ( '_blank' === $attributes['linkTarget'] ) {91			// translators: %s: Comment author name.92			$label = 'aria-label="' . esc_attr( sprintf( __( '(%s website link, opens in a new tab)' ), $comment->comment_author ) ) . '"';93		}94		$avatar_block = sprintf( '<a href="%1$s" target="%2$s" %3$s class="wp-block-avatar__link">%4$s</a>', esc_url( $comment->comment_author_url ), esc_attr( $attributes['linkTarget'] ), $label, $avatar_block );95	}96	return sprintf( '<div %1$s>%2$s</div>', $wrapper_attributes, $avatar_block );97}

Changelog

Introduced in 6.0.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 7.1.0 tag, from src/wp-includes/blocks/avatar.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.