get_post_type_archive_feed_link( string $post_type, string $feed = '' ): string|false
Retrieves the permalink for a post type archive feed.
Parameters
-
$post_typestring Required -
Post type.
-
$feedstring Optional -
Feed type. Possible values include
'rss2','atom'.
Default is the value of get_default_feed() .Default:
''
Return
string|false The post type feed permalink. False if the post type does not exist or does not have an archive.
Source
File: wp-includes/link-template.php.
View all references
function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
$default_feed = get_default_feed();
if ( empty( $feed ) ) {
$feed = $default_feed;
}
$link = get_post_type_archive_link( $post_type );
if ( ! $link ) {
return false;
}
$post_type_obj = get_post_type_object( $post_type );
if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) && $post_type_obj->rewrite['feeds'] ) {
$link = trailingslashit( $link );
$link .= 'feed/';
if ( $feed != $default_feed ) {
$link .= "$feed/";
}
} else {
$link = add_query_arg( 'feed', $feed, $link );
}
/**
* Filters the post type archive feed link.
*
* @since 3.1.0
*
* @param string $link The post type archive feed link.
* @param string $feed Feed type. Possible values include 'rss2', 'atom'.
*/
return apply_filters( 'post_type_archive_feed_link', $link, $feed );
}
Hooks
-
apply_filters( 'post_type_archive_feed_link',
string $link ,string $feed ) -
Filters the post type archive feed link.
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
If the supplied arguement
$feedis empty, the result ofget_default_feed()is used (the default feed is ‘rss2’, unless it is changed via thedefault_feedfilter).