';
}
} else {
// this is the last item, make sure we close off all tags
for ( $current_depth; $current_depth >= $numbered_items_min; $current_depth-- ) {
$html .= '';
if ( $current_depth !== $numbered_items_min ) {
$html .= '';
}
}
}
}
return $html;
}
/**
* Returns a string with all items from the $find array replaced with their matching
* items in the $replace array. This does a one to one replacement (rather than
* globally).
*
* This function is multibyte safe.
*
* $find and $replace are arrays, $string is the haystack. All variables are
* passed by reference.
*/
private function mb_find_replace( &$find = false, &$replace = false, &$string = '' ) {
if ( is_array( $find ) && is_array( $replace ) && $string ) {
$count_find = count( $find );
// check if multibyte strings are supported
if ( function_exists( 'mb_strpos' ) ) {
for ( $i = 0; $i < $count_find; $i++ ) {
$string =
mb_substr( $string, 0, mb_strpos( $string, $find[ $i ] ) ) . // everything before $find
$replace[ $i ] . // its replacement
mb_substr( $string, mb_strpos( $string, $find[ $i ] ) + mb_strlen( $find[ $i ] ) ); // everything after $find
}
} else {
for ( $i = 0; $i < $count_find; $i++ ) {
$string = substr_replace(
$string,
$replace[ $i ],
strpos( $string, $find[ $i ] ),
strlen( $find[ $i ] )
);
}
}
}
return $string;
}
/**
* This function extracts headings from the html formatted $content. It will pull out
* only the required headings as specified in the options. For all qualifying headings,
* this function populates the $find and $replace arrays (both passed by reference)
* with what to search and replace with.
*
* Returns a html formatted string of list items for each qualifying heading. This
* is everything between and NOT including
and
*/
public function extract_headings( &$find, &$replace, $content = '' ) {
$matches = [];
$anchor = '';
$items = false;
// reset the internal collision collection as the_content may have been triggered elsewhere
// eg by themes or other plugins that need to read in content such as metadata fields in
// the head html tag, or to provide descriptions to twitter/facebook
$this->collision_collector = [];
if ( is_array( $find ) && is_array( $replace ) && $content ) {
// filter the content
$content = apply_filters( 'toc_extract_headings', $content );
// get all headings
// the html spec allows for a maximum of 6 heading depths
if ( preg_match_all( '/(]*>).*<\/h\2>/msuU', $content, $matches, PREG_SET_ORDER ) ) {
// remove undesired headings (if any) as defined by heading_levels
if ( count( $this->options['heading_levels'] ) !== 6 ) {
$new_matches = [];
$count_matches = count( $matches );
for ( $i = 0; $i < $count_matches; $i++ ) {
if ( in_array( (int) $matches[ $i ][2], $this->options['heading_levels'], true ) ) {
$new_matches[] = $matches[ $i ];
}
}
$matches = $new_matches;
}
// remove specific headings if provided via the 'exclude' property
if ( $this->options['exclude'] ) {
$excluded_headings = explode( '|', $this->options['exclude'] );
$count_excluded_headings = count( $excluded_headings );
if ( $count_excluded_headings > 0 ) {
for ( $j = 0; $j < $count_excluded_headings; $j++ ) {
// escape some regular expression characters
// others: http://www.php.net/manual/en/regexp.reference.meta.php
$excluded_headings[ $j ] = str_replace(
[ '*' ],
[ '.*' ],
trim( $excluded_headings[ $j ] )
);
}
$new_matches = [];
$count_matches = count( $matches );
for ( $i = 0; $i < $count_matches; $i++ ) {
$found = false;
$count_excluded_headings = count( $excluded_headings );
for ( $j = 0; $j < $count_excluded_headings; $j++ ) {
if ( @preg_match( '/^' . $excluded_headings[ $j ] . '$/imU', wp_strip_all_tags( $matches[ $i ][0] ) ) ) {
$found = true;
break;
}
}
if ( ! $found ) {
$new_matches[] = $matches[ $i ];
}
}
if ( count( $matches ) !== count( $new_matches ) ) {
$matches = $new_matches;
}
}
}
// remove empty headings
$new_matches = [];
$count_matches = count( $matches );
for ( $i = 0; $i < $count_matches; $i++ ) {
if ( trim( wp_strip_all_tags( $matches[ $i ][0] ) ) !== false ) {
$new_matches[] = $matches[ $i ];
}
}
if ( count( $matches ) !== count( $new_matches ) ) {
$matches = $new_matches;
}
// check minimum number of headings
if ( count( $matches ) >= $this->options['start'] ) {
$count_matches = count( $matches );
for ( $i = 0; $i < $count_matches; $i++ ) {
// get anchor and add to find and replace arrays
$anchor = $this->url_anchor_target( $matches[ $i ][0] );
$find[] = $matches[ $i ][0];
$replace[] = str_replace(
[
$matches[ $i ][1], // start of heading
'', // end of heading
],
[
$matches[ $i ][1] . '',
'',
],
$matches[ $i ][0]
);
// assemble flat list
if ( ! $this->options['show_heirarchy'] ) {
$items .= '
';
}
}
// build a hierarchical toc?
// we could have tested for $items but that var can be quite large in some cases
if ( $this->options['show_heirarchy'] ) {
$items = $this->build_hierarchy( $matches );
}
}
}
}
return $items;
}
/**
* Returns true if the table of contents is eligible to be printed, false otherwise.
*/
public function is_eligible( $shortcode_used = false ) {
global $post;
// do not trigger the TOC on REST Requests
if ( defined( 'REST_REQUEST' ) && REST_REQUEST ) {
return false;
}
// do not trigger the TOC when displaying an XML/RSS feed
if ( is_feed() ) {
return false;
}
// if the shortcode was used, this bypasses many of the global options
if ( false !== $shortcode_used ) {
// shortcode is used, make sure it adheres to the exclude from
// homepage option if we're on the homepage
if ( ! $this->options['include_homepage'] && is_front_page() ) {
return false;
} else {
return true;
}
} else {
if (
( in_array( get_post_type( $post ), $this->options['auto_insert_post_types'], true ) && $this->show_toc && ! is_search() && ! is_archive() && ! is_front_page() ) ||
( $this->options['include_homepage'] && is_front_page() )
) {
if ( $this->options['restrict_path'] ) {
if ( strpos( $_SERVER['REQUEST_URI'], $this->options['restrict_path'] ) === 0 ) {
return true;
} else {
return false;
}
} else {
return true;
}
} else {
return false;
}
}
}
public function the_content( $content ) {
global $post;
$items = '';
$css_classes = '';
$anchor = '';
$find = [];
$replace = [];
$custom_toc_position = strpos( $content, '' );
if ( $this->is_eligible( $custom_toc_position ) ) {
$items = $this->extract_headings( $find, $replace, $content );
if ( $items ) {
// do we display the toc within the content or has the user opted
// to only show it in the widget? if so, then we still need to
// make the find/replace call to insert the anchors
if ( $this->options['show_toc_in_widget_only'] && ( in_array( get_post_type(), $this->options['show_toc_in_widget_only_post_types'], true ) ) ) {
$content = $this->mb_find_replace( $find, $replace, $content );
} else {
// wrapping css classes
switch ( $this->options['wrapping'] ) {
case TOC_WRAPPING_LEFT:
$css_classes .= ' toc_wrap_left';
break;
case TOC_WRAPPING_RIGHT:
$css_classes .= ' toc_wrap_right';
break;
case TOC_WRAPPING_NONE:
default:
// do nothing
}
// colour themes
switch ( $this->options['theme'] ) {
case TOC_THEME_LIGHT_BLUE:
$css_classes .= ' toc_light_blue';
break;
case TOC_THEME_WHITE:
$css_classes .= ' toc_white';
break;
case TOC_THEME_BLACK:
$css_classes .= ' toc_black';
break;
case TOC_THEME_TRANSPARENT:
$css_classes .= ' toc_transparent';
break;
case TOC_THEME_GREY:
default:
// do nothing
}
// bullets?
if ( $this->options['bullet_spacing'] ) {
$css_classes .= ' have_bullets';
} else {
$css_classes .= ' no_bullets';
}
if ( $this->options['css_container_class'] ) {
$css_classes .= ' ' . $this->options['css_container_class'];
}
$css_classes = trim( $css_classes );
// an empty class="" is invalid markup!
if ( ! $css_classes ) {
$css_classes = ' ';
}
// add container, toc title and list items
$html = '