Retrieve a Breadcrumb Trail for a Term

Breadcrumb NavXT will return a Schema.org BreadcrumbList JSON-LD object containing the breadcrumb trail for the passed in term ID and taxonomy. The following is the definition and available arguments for this endpoint:

GET /bcn/v1/term/<taxonomy>/<id>

  • id(integer)(required) The ID for the term to retrieve
  • taxonomy(string)(required) The taxonomy type of the term to retrieve

Retrieve a Breadcrumb Trail for a Post

Breadcrumb NavXT will return a Schema.org BreadcrumbList JSON-LD object containing the breadcrumb trail for the passed in post ID. The following is the definition and available arguments for this endpoint:

GET /bcn/v1/post/<id>

  • id(integer)(required) The ID for the post (of any post type) to retrieve
Updated:

Retrieve a Breadcrumb Trail for an Author

Breadcrumb NavXT will return a Schema.org BreadcrumbList JSON-LD object containing the breadcrumb trail for the passed in author ID. The following is the definition and available arguments for this endpoint:

GET /bcn/v1/author/<id>

  • id(integer)(required) The ID for the author to retrieve
Updated:

bcn_display_attributes

This filter is applied within the bcn_breadcrumb_trail class in the display_loop() function. This filter was introduced in version 6.0 to replace the deprecated bcn_li_attributes. It receives three parameters:

  • $li_attributes(string)(required) The attributes placed in the li tag that wraps the each breadcrumb
  • $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 not suitable ID exists

Related Articles

bcn_default_hierarchy_display

This filter is applied within the breadcrumb_navxt class in the find_posttypes() function. It provides a method to override the default hierarchy display choice for custom post types. This filter was introduced in version 6.0. It receives three parameters:

  • $default_hierarchy_display(boolean)(required) The default choice to either display or not display a hierarchy for the custom post type
  • $post_type(string)(optional) The name of the post type that the default hierarchy type applies to
  • $hierarchy_type(string)(optional) The hierarchy type (BCN_DATE, BCN_POST_PARENT, or a valid taxonomy name) that Breadcrumb NavXT is going to use as the default for the custom post type