InMotion Hosting Support Center
This is archived and longer maintained. Any information contained in this article may be out of date.

Joomla 2.5 has reached its end of life as for 12/31/2014. Please be advised this may be a security risk to your website. You can view more information about the end of life here.


In our previous Joomla 2.5 plugin tutorial, we showed you how to add a paramter to a plugin. The main focus of the article was to give you example code, and in this tutorial we'll go into more detail on what the code actually controls.

Starting off, here's the parameter that we added:

<field name="alt-text" type="text" default="" label="Alternative Text" description="Besides Hello World, you can specify other text here to print to the screen instead." />

 

Field Label

In our example, we set the field label as Alternative Text. This label controls what the user sees the setting labeled as when configuring.

plugin-label

 

Field Description

The field description is the info / help text the user sees when they mouse over the field label. Our field description was set to:

Besides Hello World, you can specify other text here to print to the screen instead.
plugin-description

 

Field Name

The field name is used when referencing the variable. For example, because we set the field name as "alt-text", we reference this name when checking for its value:

$this->params->get('alt-text')

 

Field Type

If you're familiar with HTML forms, there are various ways to get input. For example, you can use checkboxes, radio buttons, or areas for text input. As we set the type as text, it allows the user to type in text.

 

Field Default

If the user does not enter / select a value for the parameter, you can set a default setting. For example, we could have set alt-text to Hello World, so if the user doesn't type in custom text it would default to "Hello World".

Joomla Community Google+ Hangout #3

June 3rd, 2014

Thank you @RustyJoomla for letting me speak on the Joomla Community Google+ Hangout!

Click here to watch!

Related Questions

Here are a few questions related to this article that our customers have asked:
Ooops! It looks like there are no questions about this page.
Would you like to ask a question about this page? If so, click the button below!
Ask a Question

Support Center Login

Our Login page has moved, Click the button below to be taken to the login page.

Post a Comment

Name:
Email Address:
Phone Number:
Comment:
Submit

Please note: Your name and comment will be displayed, but we will not show your email address.

0 Questions & Comments

Post a comment

Back to first comment | top

Need more Help?

Search

Ask the Community!

Get help with your questions from our community of like-minded hosting users and InMotion Hosting Staff.

Current Customers

Chat: Click to Chat Now E-mail: support@InMotionHosting.com
Call: 888-321-HOST (4678) Ticket: Submit a Support Ticket

Not a Customer?

Get web hosting from a company that is here to help. Sign up today!