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.
$return the first parameter, it is a boolean and controls whether or not the breadcrumb trail is returned or echoed. Set to true to return the assembled breadcrumb trail string. It defaults to false if no value is passed in.
$linked the second parameter, it is a boolean and controls whether or not the breadcrumbs in the breadcrumb trail are linked (if anchors are generated or not). Set to false to get a string without anchors. It defaults to true if no value is passed in.
$reverse the third parameter, it is a boolean and controls the order the breadcrumbs are arranged within the trail. Set to true to have the current item’s breadcrumb show up first in the breadcrumb trail (this is revered of the normal behavior). It defaults to false if no value is passed in.
$show_current_item the fouth parameter, it is a boolean and controls whether or not the current item is included in the breadcrumb trail. Set to true to have the current item’s breadcrumb show up in the breadcrumb trail (this is revered of the normal behavior). It defaults to false if no value is passed in.
$use_taxonomy the fifth parameter, it is a string and controls what taxonomies the attribute breadcrumb trails are generated for. Set to a specific taxonomy to restrict the breadcrumb trail generation to a single taxonomy. It defaults to all if no value is passed in.
