get_wp_title_rss( string $deprecated = '–' ): string

Compatibility

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

Parameters

$deprecatedstringoptional

Unused.Default: '–'

Return value

string

The document title.

Performance profile

How much work a call to get_wp_title_rss() 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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

11–23

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

Plugin surface

1 hook

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

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, query, 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 · 2 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while get_wp_title_rss() runs, in this order:

1. 1
   apply_filters( get_wp_title_rss )filterline 118 (+15 into the body)

   Filters the blog title for use as the feed title.

Uses · 4

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_get_document_title()Returns document title for the current page.

Used by · 2

• rss2_site_icon()Displays Site Icon in RSS2.
• wp_title_rss()Displays the blog title for display of the feed title.

Source code

View on Trac ↗View on GitHub ↗

103function get_wp_title_rss( $deprecated = '&#8211;' ) {104	if ( '&#8211;' !== $deprecated ) {105		/* translators: %s: 'document_title_separator' filter name. */106		_deprecated_argument( __FUNCTION__, '4.4.0', sprintf( __( 'Use the %s filter instead.' ), '<code>document_title_separator</code>' ) );107	}108 109	/**110	 * Filters the blog title for use as the feed title.111	 *112	 * @since 2.2.0113	 * @since 4.4.0 The `$sep` parameter was deprecated and renamed to `$deprecated`.114	 *115	 * @param string $title      The current blog title.116	 * @param string $deprecated Unused.117	 */118	return apply_filters( 'get_wp_title_rss', wp_get_document_title(), $deprecated );119}

Changelog

Introduced in 2.2.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.8.8 tag, from src/wp-includes/feed.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.