Table of Contents

Table of Contents functionality

link Extension name

t2/table-of-contents

link Introduction & Usage

The Table of Contents extension allows to automatically generate a table of contents for a page based on the headings found in the page content. To add the table of contents to a page, add the template to either the wp_footer or a template part.

Example:

/**
 * Trigger toc sidebar.
 */
function t2_toc_sidebar(): void {
	if ( ! function_exists( '\T2\Extensions\Library\TableOfContents\Template\render' ) ) { // phpcs:ignore
		return;
	}

	echo \T2\Extensions\Library\TableOfContents\Template\render( get_the_ID() ); // phpcs:ignore
}
add_action( 'wp_footer', 't2_toc_sidebar' );

link Properties (t2.json)

• hasToggle

  booleanfalse

  Add gui to allow toggling Table of contents on/off per post

• levels

  boolfalse

  Flatten the table of contents.

• levels

  array'h1', 'h2', 'h3', 'h4', 'h5', 'h6'

  Set which heading levels to include in the table of contents.

• postTypes

  string[]

  Post types to add table of contents

link Extension Filters

link t2/table-of-contents/blocks

/**
 * Set what blocks to extract headings from.
 *
 * @param array $blocks_to_render The blocks to render.
 */
$blocks_to_render = \apply_filters( 't2/table-of-contents/blocks', [ 'core/heading' ] );

link t2/table-of-contents/wrapper_blocks

/**
 * Set what wrapper blocks to check for headings.
 *
 * @param array $innerblocks_to_check The inner blocks to check.
 */
$innerblocks_to_check = \apply_filters( 't2/table-of-contents/wrapper_blocks', [ 'core/group', 'core/columns', 'core/column' ] );