Add a custom action

By the end of this article, you should be able to confidently create a basic action on your forum.

What is an action?

An action is a page off the base of your forum. It is comprised of two files, one is a source file, and the second is a template file.

Source File

The source file is the base foundation of the action, it loads the template along with anything else the action might need, such as permissions or additional functions.

Template File

The template file is everything that you see when you go to ?action=youraction, it is defined to the action by the actions source file.

Language Strings

The language strings define text in both the template file, and the source file so they can be edited more easily and also translated to other languages more easily.

./Themes/default/languages/Modifications.english.php

Add Before End

// Your Action Language Strings
 $txt['your_action'] = 'Your Action';
 $txt['page_title'] = 'This is your page title';

./Themes/default/languages/Who.english.php

Add Before End

// Your Action Who String
 $txt['whoall_youraction'] = 'Viewing <a href="' . $scripturl . '?action=youraction">Your Action</a>.';

The edit you make in Who.english.php defines the action for the ?action=who page. So people can see what action you are on.

Also remember to clear your forums cache or the text strings will not show up.

First of all, we need to define the action along with the source file name and function.

/index.php

Find

   	'xmlhttp' => array('Xml.php', 'XMLhttpMain'),

Add After

 		// Your Custom Action
  		'youraction' => array('YourAction.php', 'YourActionMain'),

[hr]Notes about the first edit: the array that defines actions inside index.php is alphabetically ordered, to keep everything organized, it is smart to label what the code you added was for, and also keep it alphabetically labeled. [quote]'action-in-url' => array('Source-File.php', 'FunctionToCall'),[/quote][hr]

Now that we have defined our action, lets create our Source file.

Create a file in ./Sources named "YourAction.php".

./Sources/YourAction.php

Add

<?php
 
 if (!defined('SMF'))
 	die('Hack Attempt...');
 
 function YourActionMain()
 {
 
 	// Globalize what we need...
 	global $context, $scripturl, $txt;
 
 	// Load our template
 	loadTemplate('YourAction');
 
 	// Define a page title
 	$context['page_title'] = $txt['page_title'];
 
 	// Define our link tree
 	$context['linktree'][] = array(
   		'url' => $scripturl. '?action=youraction',
  		'name' => $txt['your_action'],
 	);
 
 }
 
 ?>

[hr]Notes about the source file: first of all, we make sure we are accessing the source file via SMF so that people can not directly access the file. Then, we globalize the variables we need for the main function, load our template, define our page title and our link tree item[hr]

Now that we have our action defined, and a source file for our base, lets work on our template file.

Go to ./Themes/default and create a file named "YourAction.template.php".

Once created, complete the following edit.

./Themes/default/YourAction.template.php

Add

<nowiki><?php

function template_main()
{

	// Globalize what we need...
	global $txt;

	// Catbg header

echo '

', $txt['your_action'], '

';

	// Windowbg2 Content

echo '

Your Page Content

';

}

?><nowiki>

Now our action should be accessible and working correctly, except no text will be showing, so lets define the strings we used.

Another optional edit would be to add a navigation tab for it. Take a peak at the document on adding tabs to do that.