This function provides a means of retrieving the preferred term according to Breadcrumb NavXT Paths’ view of the world. This function was introduced in 1.6.0. It receives two parameters:
$post_id– (int)(required) The ID of the post to retrieve the preferred term for
$taxonomy – (string)(required) The taxonomy to retrieve the preferred term from
This function returns the WP_Term instance for the preferred term, if found. Otherwise, it returns FALSE.
This filter is applied within the bcn_paths_term_metabox class in the paths_meta_box member function, the result of this filter is passed into the dropdown_posts member function. This affects the posts displayed in the Page Map for Breadcrumbs dropdown. This filter was introduced in 1.6.0. It receives three parameters:
$get_post_args– (array)(required) The array of arguments being passed into the call to get_posts within paths_metabox::dropdown_posts function
$term – (WP_Term)(optional) The term object for the term being edited
$taxonomy – (string)(optional) The taxonomy of the term being edited
This filter is applied within the bcn_breadcrumb class in the set_linked member function before setting the internal $linked property. This filter was introduced in 6.5. It receives three parameters:
$linked– (bool)(required) Whether or not the breadcrumb is linked
$type – (array)(optional) The array of type strings for the breadcrumb
$id – (int|NULL)(optional) The ID of the resource represented by the breadcrumb, will be NULL if no suitable ID exists
This filter is applied within the breadcrumb_navxt_trail class in the type_archive() function. This filter was introduced in version 6.4. It receives two parameters:
$display – (boolean)(required) Whether or not to add the post type (filterable via bcn_type_archive_post_type) archive breadcrumb to the breadcrumb trail for term archives
$taxonomy – (string)(optional) The name of the taxonomy for term archive the breadcrumb trail is being generated for
This filter is applied within the bcn_breadcrumb_trail class in the post_parents() and do_post()functions. This filter is intended to allow users to override the default behavior of Breadcrumb NavXT to include private posts in the breadcrumb trail of their published children. This filter was introduced in version 6.4. It receives two parameters:
$display – (boolean)(required) Whether or not the post specified in the second parameter is to be included in the breadcrumb trail
$ID – (integer)(optional) The ID of the post in question