Twenty Fifteen: Incorrect use of sprintf() and _x() in template-tags.php

[aprea]

The current /inc/template-tags.php has several incorrect uses of sprintf() and _x, see example below:

if ( is_attachment() && wp_attachment_is_image() ) {
	// Retrieve attachment metadata.
	$metadata = wp_get_attachment_metadata();

	printf( '<span class="full-size-link">%1$s<a href="%2$s">%3$s &times; %4$s</a></span>',
		sprintf( _x( '<span class="screen-reader-text">Full size</span>', 'Used before full size attachment link.', 'twentyfifteen' ) ),
		esc_url( wp_get_attachment_url() ),
		$metadata['width'],
		$metadata['height']
	);
}

Two problems here:

1. sprintf() is only passing 1 argument.
2. _x() includes HTML markup in the replacement text.

[obenland]

If the screen reader text wrapper would be placed in the first format string, sprintf() could be removed all together.

[obenland]

Also: Nice find aprea, way to go with your first ticket!

[aprea]

Thanks obenland!

I was speaking to Dion about this last night on Slack, he suggested that it was perhaps done this way to improve code readability.

I've attached another patch that removes the sprintf()s and places the screen reader text wrapper directly in the first format string as you suggested.

[aprea]

Removes the sprintf()s and places the screen reader text wrapper directly in the first format string.

[iandstewart]

Fixed in r30312.

Nice work, @aprea!

[dd32]

FWIW, @aprea, I was thinking something like this, not using the extra sprintf:

printf( '<span class="full-size-link">%1$s<a href="%2$s">%3$s &times; %4$s</a></span>',
		'<span class="screen-reader-text">' . _x( 'Full size', 'Used before full size attachment link.', 'twentyfifteen' ) . '</span>',
		esc_url( wp_get_attachment_url() ),
		$metadata['width'],
		$metadata['height']
	);

Of course, it's fine-as-is in r30312 :)

[aprea]

Oh right, of course! I don't think my brain was working at 100% capacity last night ;)