get_the_archive_description(): string

Compatibility

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

Return value

string

Archive description.

Performance profile

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

13–15

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_the_archive_description' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place 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 query, option, 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 · 3 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( get_the_archive_description )filterline 1860 (+16 into the body)

   Filters the archive description.

Uses · 6

• is_author()Determines whether the query is for an existing author archive page.
• get_the_author_meta()Retrieves the requested data of the author of the current post.
• is_post_type_archive()Determines whether the query is for an existing post type archive page.
• get_the_post_type_description()Retrieves the description for a post type archive.
• term_description()Retrieves term description.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• the_archive_description()Displays category, tag, term, or author description.

Source code

View on Trac ↗View on GitHub ↗

1844function get_the_archive_description() {1845	if ( is_author() ) {1846		$description = get_the_author_meta( 'description' );1847	} elseif ( is_post_type_archive() ) {1848		$description = get_the_post_type_description();1849	} else {1850		$description = term_description();1851	}1852 1853	/**1854	 * Filters the archive description.1855	 *1856	 * @since 4.1.01857	 *1858	 * @param string $description Archive description to be displayed.1859	 */1860	return apply_filters( 'get_the_archive_description', $description );1861}

Changelog

Introduced in 4.1.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 7.0.4 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.