sp_ColumnEnd

Important Note:  The contents of this document applies ONLY to version 5.x.x of Simple:Press.  It likely does NOT apply to version 6.x.x (our latest version).

Description

sp_ColumnEnd() – This function is used to close an existing column container div section (typically opened with sp_ColumnStart()) within the forum theme display.

Usage

sp_ColumnEnd($args=”, $columnName=”);

Arguments

$args – List of arguments for controlling display.
Type:
(string) (optional)
Default:
‘tagClass’ => ”
‘tagId’ => ”
‘echo’ => 1

‘tagClass’: Class to apply to an empty div output before closing the current column container section.
‘tagId’: ID to apply to an empty div output before closing the current column container section.
‘echo’: Controls whether display code is output or returned to caller.

$columnName – Special name applied to column. This name is only used for hooks fired within this function.
Type:
(string) (optional)
Default:
None

Special Notes

If either the $tagID or $tagClass arguments are specified, an empty div container (<div></div>) with the specified ID or Class will be output prior to closing the column container section. This empty div container could be used to clear floats or other information via javascript or other.

Examples

Close an open column display section container.

sp_ColumnEnd();

Close an open column display container. An empty div container with class of spClear will also be output to clear any floats.

sp_ColumnStart('tagClass=spClear');

Actions and Hooks Used in Template Tag

  • apply_filters(‘sph_ColumnEnd_args’, $a); – Allows modification of the arguments to the template tag. $a contains the parsed arguments.
  • do_action(‘sph_BeforeColumnEnd’, $columnName, $a); – Hook fired before the container opening div is output. Hook is generic for every Column End.
  • do_action(‘sph_BeforeColumnEnd_’.$columnName, $a); – Hook fired before the container opening div is output. Hook is specific to the named Column End.
  • apply_filters(‘sph_ColumnEnd’, $out, $columnName, $a); – Allows modification of the container section just prior to being closed. Hook is generic for every Column End.
  • do_action(‘sph_ColumnEnd’.$columnName, $a); – Allows modification of the container section just prior to being closed. Hook is specific to the named Column End.
  • do_action(‘sph_AfterColumnEnd’, $columnName, $a); – Hook fired after the container div closing section is closed. Hook is generic for every Column End.
  • do_action(‘sph_AfterColumnEnd_’.$columnName, $a); – Hook fired after the container div closing section is closed. Hook is specific to the named Column End.

Changelog

Since Simple:Press version 5.0.

Codex page sync’d to code version 5.4.1.

Source Code

sp_ColumnEnd() is located in simple-press/forum/content/sp-common-view-functions.php.

Related

sp_SectionStart
sp_SectionEnd
sp_ColumnStart
sp_InsertBreak

Posted in