Simple:Press Documentation

Template Tag: Forum Home Link

The Template Forum Home Link displays a standard link to your forums home page.

This template tag is included in the Template Tags and Widgets plugin available on the Simple:Press Our Plugin Library page.

The function used is sp_ForumHomeLinkTag() and the file that makes the magic happen is sp-ForumHomeLink-tag.php which is located in the plugin’s template-tags/library folder.

You can pass optional arguments to the function for formatting and display.

Options

  • beforeLink – Text to show before the  forum link. Default is nothing
  •  afterLink – Text to show after the  forum link. Default is nothing
  • echo – echo content or return content. True/false and the default is true.

NOTE: True must be expressed as a 1 and False as a zero

Usage

An example of using this tag with the default settings.

<?php sp_ForumHomeLinkTag();?>

An example of using this tag and displaying text before and after the link.

<?php sp_ForumHomeLinkTag('beforeLink=Go to&afterLink=now!');?>

You can also call this function by using a shortcode on pages, posts or widgets.

[sp_forum_home_link]

The Using Plugins page describes how you obtain and install the Template Tags plugin. Once installed you would activate it from the Simple:Press administration page Available “Plugins – Install Simple:Press Plugins”

More Topics In SimplePress: Plugins


Copyright © 2006-2019 Simple:Press. All Rights Reserved.