get_the_archive_title │ filter-hook │ WP 4.1.0

Filters the archive title.

Usage

add_filter( 'get_the_archive_title', 'wp_kama_get_the_archive_title_filter', 10, 3 );

/**
 * Function for `get_the_archive_title` filter-hook.
 * 
 * @param string $title          Archive title to be displayed.
 * @param string $original_title Archive title without prefix.
 * @param string $prefix         Archive title prefix.
 *
 * @return string
 */
function wp_kama_get_the_archive_title_filter( $title, $original_title, $prefix ){

	// filter...
	return $title;
}

$title(string)

Archive title to be displayed.

$original_title(string)

Archive title without prefix.

$prefix(string)

Archive title prefix.

Changelog

Where the hook is called

return apply_filters( 'get_the_archive_title', $title, $original_title, $prefix );

Where the hook is used in WordPress