bcn_register_rest_endpoint

This filter is applied within the bcn_rest_controller class in the register_rest_route() function. This filter was introduced in version 6.2. It receives four parameters:

  • $register_rest_endpoint(boolean)(required) The boolean decision whether or not to allow the REST endpoint to be registered
  • $endpoint(string)(optional) The name of the REST API endpoint being registered
  • $version(string)(optional) The REST API version of the endpoint being registered
  • $methods(array)(optional) The array of methods for the REST API endpoint being registered

Related Articles

Updated:

bcn_breadcrumb_assembled_json_ld_array

This filter is applied within the bcn_breadcrumb class in the assemble_json_ld() function. This filter was introduced in version 6.2 with three parameters. It receives three parameters:

  • $json_ld_array(array)(required) The JSON-LD array that will be returned by bcn_breadcrumb::assemble_json_ld() to filter
  • $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
Updated:

Changing the Home Breadcrumb Title

Prior to Breadcrumb NavXT 4.3.0, there was an option for setting the Home and Mainsite breadcrumb titles. However, these were removed as their functionality was completely redundant—the same behavior could be achieved by modifying the Home and Mainsite breadcrumb templates, replacing %title% and %htitle% with the desired title.

This works fine for most use cases. However, it does not work with bcn_display_json_ld() (introduced in 5.7.0). Luckily, there is an even better way to define the titles for these breadcrumbs—using the bcn_breadcrumb_title filter.

The Code

add_filter('bcn_breadcrumb_title', 'my_breadcrumb_title_swapper', 3, 10);
function my_breadcrumb_title_swapper($title, $type, $id)
{
	if(in_array('home', $type))
	{
		$title = __('Home');
	}
	return $title;
}

To force the Home breadcrumb to use ‘Home’ as the title, just place this code into your site specific plugin and activate. Want to use something else as the title? Change ‘Home’ to whatever you wish to display for the home breadcrumb.

Consider the Following

  1. Combining this method of specifying the Home title with the method of replacing %title% and %htitle% with the desired title in the Home breadcrumb templates is not recommended—the Home breadcrumb templates will take precedence.
  2. This example may be extended to modify the title for the Mainsite breadcrumb. To do so, look for main-home in the $types array instead of  home.

-John Havlik

[end of transmission, stay tuned]

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: