WordPress.org

Description

Add a new feed type like /atom1/.

Requires one-time use of flush_rules() to take effect.

Usage

<?php add_feed( $feedname, $function ); ?> Use the init action to call this function.

Parameters

$feedname

(string) (required) Name of the feed as it will appear in the feed URL

Default: None

$function

(callback) (required) Callback to run on feed display.

Default: None

Return Values

(string) 

Feed action name.

Example

 <?php
/* Add the feed. */
function my_custom_rss_init(){
	add_feed('my_custom_feed', 'my_custom_rss');
}
add_action('init', 'my_custom_rss_init');

/* Filter the type, this hook wil set the correct HTTP header for Content-type. */
function my_custom_rss_content_type( $content_type, $type ) {
	if ( 'my_custom_feed' === $type ) {
		return feed_content_type( 'rss2' );
	}
	return $content_type;
}
add_filter( 'feed_content_type', 'my_custom_rss_content_type', 10, 2 );

/* Show the RSS Feed on domain.com/?feed=my_custom_feed or domain.com/feed/my_custom_feed. */
function my_custom_rss() {
	// Do your magic, with XML for example.
}
 ?>

Change Log

Since: 2.1

Source File

add_feed() is located in wp-includes/rewrite.php

Related

Articles

• Lesson: Rewrite API Overview
• Class: WP_Rewrite() - An overview of WordPress's built-in URL rewrite class.

Hooks

• Filter: root_rewrite_rules - Filters the rewrite rules generated for the root of your weblog.
• Filter: post_rewrite_rules - Filters the rewrite rules generated for permalink URLs.
• Filter: page_rewrite_rules - Filters the rewrite rules generated for your Pages.
• Filter: date_rewrite_rules - Filters the rewrite rules generated for dated archive URLs.
• Filter: search_rewrite_rules - Filters the rewrite rules generated for search URLs.
• Filter: comments_rewrite_rules - Filters the rewrite rules generated for the latest comment feed URLs.
• Filter: author_rewrite_rules - Filters the rewrite rules generated for author archive URLs.
• Filter: rewrite_rules_array - Filters all the rewrite rules at once.
• Filter: {$permastruct}_rewrite_rules - Can be used to create or modify rewrite rules for any custom permastructs, such as taxonomies or custom post types.
• Action: generate_rewrite_rules - Runs after all the rules have been created.

Functions

• add_rewrite_tag() - Can be used to allow WordPress to recognize custom variables (particularly custom querystring variables).
• add_rewrite_rule() - Allows you to specify new, custom rewrite rules.
• add_rewrite_endpoint() - Add a new endpoint like /trackback/
• flush_rules() - Regenerate the rewrite rules and save them to the database.
• flush_rewrite_rules() - Remove rewrite rules and then recreate rewrite rules.
• generate_rewrite_rules() - Generates rewrite rules from a permalink structure
• add_permastruct() - Add a new permastruct
• add_feed()- Add a new feed type like /atom1/