Skip to content

Output Functions

gtbu edited this page Jul 8, 2024 · 3 revisions

GetHead()

Outputs CMS generated content for the page's <head> section, such as <meta> and <link> elements. gpOutput::GetHead();

GetAdminLink()

Outputs Site Map link, Login/Logout link, Powered By Link and the messages container.
Optional parameter: boolean, false will suppress the output of messages. Use echo GetMessages(); elsewhere in such cases! Defaults to true.
Example: gpOutput::GetAdminLink();

GetSitemapLink()

Outputs the link to the Site Map page.
Example: gpOutput::GetSitemapLink();

GetLoginLink()

Outputs only the login/logout link.
Optional parameter: boolean, true will overrule the configuration setting 'Show Login Link'. Defaults to false.
Example: gpOutput::GetLoginLink();

GetPoweredByLink()

Outputs only the 'Powered By' link on the home page.
Optional parameter: boolean, true will output the links on all pages, not only the home page. Defaults to false.
Example: gpOutput::GetPoweredByLink(true);

GetGadget()

Outputs a Gadget. Built-in Gadgets are Contact, Search, Admin Link and Login Link

( gpOutput::GetGadget(the_gadget_id) )

Example: `gpOutput::GetGadget('Search');

Get()

A common, multi-purpose output function

Example: gpOutput::Get();
This will output an 'empty' area. Use Layout Editor to insert arbitrary areas such as Extra Content, Menus or Gadgets here.

Menus

Example: gpOutput::Get('Menu');
Outputs the main menu but only its 1st level.

Example: gpOutput::Get('TopTwoMenu');
Outputs a 2-level main menu.

Example: gpOutput::Get('FullMenu');
Outputs a main menu with all existing sublevels.

Example: gpOutput::Get('ExpandMenu');
Description pending.

Example: gpOutput::Get('ExpandLastMenu');
Description pending.

Example: gpOutput::Get('SubMenu');
Description pending.

Example: gpOutput::Get('BottomTwoMenu');
Description pending.

Example: gpOutput::Get('MiddleSubMenu');
Description pending.

Example: gpOutput::Get('BottomSubMenu');
Description pending.

Example: gpOutput::Get('Breadcrumbs');
Description pending.

Example: gpOutput::Get('CustomMenu', 1, 4, 1, 1, 'm1');
Description pending.

Extra Content

Example: gpOutput::Get('Extra', 'Side_Menu');
Outputs the 'Side Menu' extra content.