breadcrumbspress_builder_for_search_results
Developer Knowledge Level
This content is intended for WordPress developers, and it may require coding knowledge of WordPress, PHP, and JavaScript. Code examples provided here may contain errors or needs some additional coding. Make sure to test the code before using it on a live website!
Definition
apply_filters( "breadcrumbspress_builder_for_search_results", $breadcrumbs, $query, $use_template );
Arguments
Name
Type
Description
$breadcrumbs
array
Breadcrumb trail as an array of Crumb objects.
$query
string
Search query.
$use_template
boolean
Whether the configured title and display templates are used.
Returns
Return the breadcrumb array, containing Crumb objects in the intended order.
Filters the breadcrumb trail built for a search results page.
This hook is used when building the current-request trail. It is not a universal filter for trails generated directly for a specific post or term. The current generator caches a nonempty result for the request.
Example
This example registers a callback for the filter. Adapt the values and conditions to your site.
add_filter( 'breadcrumbspress_builder_for_search_results', function( $breadcrumbs, $query, $use_template ) {
if ( isset( $breadcrumbs['home'] ) ) {
$breadcrumbs['home']->title = 'Start';
}
return $breadcrumbs;
}, 10, 3 );