function theme_tableofcontents_back_to_top in Table of Contents 7

Same name and namespace in other branches

1. 6.3 tableofcontents.pages.inc \theme_tableofcontents_back_to_top()
2. 7.2 tableofcontents.themes.inc \theme_tableofcontents_back_to_top()

Theme the output of the Back to Top link.

This way users can easily add an image instead of using the CSS arrow up as we have in the module.

Parameters

$toc A TOC object with the options and levels.:

Return value

Rendered HTML to be displayed.

1 theme call to theme_tableofcontents_back_to_top()

_tableofcontents_headers in ./tableofcontents.pages.inc

This function goes through all the headers found in the text.

File

./tableofcontents.pages.inc, line 1117

Applies the filter functions.

Code

function theme_tableofcontents_back_to_top($variables) {
  $toc = $variables['toc'];
  return '<div class="toc-back-to-top"><a href="#' . $toc->back_to_top_anchor . '">' . $toc->back_to_top . '</a></div>';
}