Theme framework: Breadcrumbs Functions

Provides procedural entry points for the shared breadcrumb module.

Breadcrumbs::load_functions() loads this file during module initialization. Call these helpers from frontend templates after WordPress has resolved the request. All helpers use the canonical module instance, including child replacements.

Capabilities and extension points

Prints breadcrumbs at the current template position.

Disable the breadcrumbs/automatic theme filter when choosing a custom placement. The first rendering entry point wins; later calls print nothing. The module's shared template handles escaping and presentation.

• see Breadcrumbs::render()

Gets breadcrumb HTML for insertion at a chosen template position.

This consumes the shared placement just like display_breadcrumbs(). Insert the returned markup into the page; do not use this helper to inspect a trail or populate a discarded buffer. Use get_breadcrumb_items() for inspection. Disable the breadcrumbs/automatic theme filter for custom placement.

• see Breadcrumbs::get_html()
• return string Navigation markup, or an empty string when hidden or already rendered.

Gets the shared breadcrumb items without consuming their visible placement.

Items contain a plain-text label, an HTTP(S) URL or empty string, and a hide_in_schema flag. The module caches this trail for HTML and structured data consistency. Register item filters before its first lookup; changing the returned array does not update the shared trail. Escape values at output if building a custom presentation from these items.

• see Breadcrumbs::get_items()
• return array[] Normalized breadcrumb items, or an empty array when disabled.

Source reference

This editable reference page is based on the PHP documentation in breadcrumbs-functions.php.