get_post_format_link( string $format ): string|WP_Error|false

Parameters

$formatstring

The post format slug.

Return

string|WP_Error|false

The post format term link.

Uses · 3

• get_term_by()Gets all term data from database by term field and data.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_term_link()Generates a permalink for a taxonomy term archive.

Used by · 5

• Twenty_Fourteen_Ephemera_Widget::widget()Output the HTML for this widget.
• WP_REST_Post_Format_Search_Handler::prepare_item()Prepares the search result for a given post format.
• WP_REST_Post_Format_Search_Handler::search_items()Searches the post formats for a given search request.
• twentyfifteen_entry_meta()Prints HTML with meta information for the categories, tags.
• twentysixteen_entry_meta()Prints HTML with meta information for the categories, tags.

Source

View on Trac ↗View on GitHub ↗

149function get_post_format_link( $format ) {150	$term = get_term_by( 'slug', 'post-format-' . $format, 'post_format' );151	if ( ! $term || is_wp_error( $term ) ) {152		return false;153	}154	return get_term_link( $term );155}

History

Introduced in 3.1.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.7.7 tag, from src/wp-includes/post-formats.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.