WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_post_format_link()

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

In this article

Back to top

Returns a link to a post format index.

Parameters

$formatstringrequired
The post format slug.

Return

string|WP_Error|false The post format term link.

Source

function get_post_format_link( $format ) {
	$term = get_term_by( 'slug', 'post-format-' . $format, 'post_format' );
	if ( ! $term || is_wp_error( $term ) ) {
		return false;
	}
	return get_term_link( $term );
}

View all references View on Trac View on GitHub

UsesDescription
get_term_link()wp-includes/taxonomy.php

Generates a permalink for a taxonomy term archive.

get_term_by()wp-includes/taxonomy.php

Gets all term data from database by term field and data.

is_wp_error()wp-includes/load.php

Checks whether the given variable is a WordPress Error.

Show 1 moreShow less
Used byDescription
WP_REST_Post_Format_Search_Handler::search_items()wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php

Searches the post formats for a given search request.

WP_REST_Post_Format_Search_Handler::prepare_item()wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php

Prepares the search result for a given post format.

Changelog

VersionDescription
3.1.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.