feed_links_extra( array $args = array() )

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarrayoptional

Optional arguments.Default: array()

Performance profile

How much work a call to feed_links_extra() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

63–126

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 338.

Plugin surface

9 hooks

Third-party callbacks on 'feed_links_extra_args', 'feed_links_show_comments_feed', 'feed_links_extra_show_post_comments_feed' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below feed_links_extra()
• optionoption read or writeget_option()one call below feed_links_extra()

Further down the call graph this can also reach cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 42 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost feed_links_extra() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 9

9 hooks fire while feed_links_extra() runs, in this order:

1. 1
   apply_filters( feed_links_extra_args )filterline 3333 (+29 into the body)

   Filters the extra feed links arguments.

2. 2
   apply_filters( feed_links_show_comments_feed )filterline 3344 (+40 into the body)

   Filters whether to display the comments feed link.

3. 3
   apply_filters( feed_links_extra_show_post_comments_feed )filterline 3359 (+55 into the body)

   Filters whether to display the post comments feed link.

4. 4
   apply_filters( feed_links_extra_show_post_type_archive_feed )filterline 3388 (+84 into the body)

   Filters whether to display the post type archive feed link.

5. 5
   apply_filters( feed_links_extra_show_category_feed )filterline 3416 (+112 into the body)

   Filters whether to display the category feed link.

6. 6
   apply_filters( feed_links_extra_show_tag_feed )filterline 3440 (+136 into the body)

   Filters whether to display the tag feed link.

7. 7
   apply_filters( feed_links_extra_show_tax_feed )filterline 3464 (+160 into the body)

   Filters whether to display the custom taxonomy feed link.

8. 8
   apply_filters( feed_links_extra_show_author_feed )filterline 3491 (+187 into the body)

   Filters whether to display the author feed link.

9. 9
   apply_filters( feed_links_extra_show_search_feed )filterline 3513 (+209 into the body)

   Filters whether to display the search results feed link.

Uses · 31

• _x()Retrieves translated string with gettext context.
• __()Retrieves the translation of $text.
• wp_parse_args()Merges user defined arguments into defaults array.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_queried_object()Retrieves the currently queried object.
• is_singular()Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
• comments_open()Determines whether the current post is open for comments.
• pings_open()Determines whether the current post is open for pings.
• get_bloginfo()Retrieves information about the current site.
• the_title_attribute()Sanitizes the current title when retrieving or displaying.
• get_post_comments_feed_link()Retrieves the permalink for the post comments feed.
• is_post_type_archive()Determines whether the query is for an existing post type archive page.

Source code

View on Trac ↗View on GitHub ↗

3304function feed_links_extra( $args = array() ) {3305	$defaults = array(3306		/* translators: Separator between site name and feed type in feed links. */3307		'separator'     => _x( '»', 'feed link' ),3308		/* translators: 1: Site name, 2: Separator (raquo), 3: Post title. */3309		'singletitle'   => __( '%1$s %2$s %3$s Comments Feed' ),3310		/* translators: 1: Site name, 2: Separator (raquo), 3: Category name. */3311		'cattitle'      => __( '%1$s %2$s %3$s Category Feed' ),3312		/* translators: 1: Site name, 2: Separator (raquo), 3: Tag name. */3313		'tagtitle'      => __( '%1$s %2$s %3$s Tag Feed' ),3314		/* translators: 1: Site name, 2: Separator (raquo), 3: Term name, 4: Taxonomy singular name. */3315		'taxtitle'      => __( '%1$s %2$s %3$s %4$s Feed' ),3316		/* translators: 1: Site name, 2: Separator (raquo), 3: Author name. */3317		'authortitle'   => __( '%1$s %2$s Posts by %3$s Feed' ),3318		/* translators: 1: Site name, 2: Separator (raquo), 3: Search query. */3319		'searchtitle'   => __( '%1$s %2$s Search Results for “%3$s” Feed' ),3320		/* translators: 1: Site name, 2: Separator (raquo), 3: Post type name. */3321		'posttypetitle' => __( '%1$s %2$s %3$s Feed' ),3322	);3323 3324	$args = wp_parse_args( $args, $defaults );3325 3326	/**3327	 * Filters the extra feed links arguments.3328	 *3329	 * @since 6.7.03330	 *3331	 * @param array $args An array of extra feed links arguments.3332	 */3333	$args = apply_filters( 'feed_links_extra_args', $args );3334 3335	/*3336	 * The template conditionals are referring to the global query, so the queried object is used rather than3337	 * depending on a global $post being set.3338	 */3339	$queried_object = get_queried_object();3340	if ( is_singular() && $queried_object instanceof WP_Post ) {3341		$post = $queried_object;3342 3343		/** This filter is documented in wp-includes/general-template.php */3344		$show_comments_feed = apply_filters( 'feed_links_show_comments_feed', true );3345 3346		/**3347		 * Filters whether to display the post comments feed link.3348		 *3349		 * This filter allows to enable or disable the feed link for a singular post3350		 * in a way that is independent of {@see 'feed_links_show_comments_feed'}3351		 * (which controls the global comments feed). The result of that filter3352		 * is accepted as a parameter.3353		 *3354		 * @since 6.1.03355		 *3356		 * @param bool $show_comments_feed Whether to display the post comments feed link. Defaults to3357		 *                                 the {@see 'feed_links_show_comments_feed'} filter result.3358		 */3359		$show_post_comments_feed = apply_filters( 'feed_links_extra_show_post_comments_feed', $show_comments_feed );3360 3361		if ( $show_post_comments_feed && ( comments_open( $post ) || pings_open( $post ) || (int) $post->comment_count > 0 ) ) {3362			$title = sprintf(3363				$args['singletitle'],3364				get_bloginfo( 'name' ),3365				$args['separator'],3366				the_title_attribute(3367					array(3368						'echo' => false,3369						'post' => $post,3370					)3371				)3372			);3373 3374			$feed_link = get_post_comments_feed_link( $post->ID );3375 3376			if ( $feed_link ) {3377				$href = $feed_link;3378			}3379		}3380	} elseif ( is_post_type_archive() ) {3381		/**3382		 * Filters whether to display the post type archive feed link.3383		 *

Changelog

Introduced in 2.8.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.9.7 tag, from src/wp-includes/general-template.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.