Please note: This website includes an accessibility system. Press Control-F11 to adjust the website to people with visual disabilities who are using a screen reader; Press Control-F10 to open an accessibility menu.
There is official documentation that references what headers to use in your DocBlocks (such as @copyright and @license), but documentation is missing that outlines what values to use for each header.
In an effort to learn what values to use per each header, we have scanned the Joomla code and pulled out how each header is used. The idea behind this page is to show you how the @link tag has been used in the past within the Joomla code so learn how to use it in your future documentation.
Value Count
The following table shows the various different values for @link, and how many times each value has been used.
* @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
This tag: * @link * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. has been used a total of 21 times within the following files:
administrator/components/com_contact/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_search/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_menus/controllers/menu.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_plugins/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_users/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_joomlaupdate/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_banners/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_newsfeeds/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_content/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_login/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_languages/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_messages/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_media/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_redirect/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. components/com_contact/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. components/com_weblinks/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. components/com_search/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. components/com_wrapper/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. components/com_users/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. components/com_newsfeeds/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. components/com_content/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
This tag: * @link https://php.net/manual/en/keyword.extends.php PHP4 extends documentation has been used a total of 16 times within the following files:
This tag: * @link https://php.net/manual/en/language.oop5.basic.php#language.oop5.basic.extends PHP5 extends documentation has been used a total of 16 times within the following files:
* @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
This tag: * @link * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. has been used a total of 10 times within the following files:
administrator/components/com_weblinks/controller.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_installer/controller.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_config/controller.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_finder/controller.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_joomlaupdate/controllers/update.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_banners/controllers/tracks.raw.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. administrator/components/com_tags/controller.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. components/com_finder/controllers/suggestions.json.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. libraries/legacy/controller/admin.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. libraries/legacy/controller/legacy.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
* @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
This tag: * @link * @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional. has been used a total of 2 times within the following files:
libraries/cms/application/cms.php: * @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional. libraries/legacy/application/application.php: * @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
* {@link $_encoding} setting.
This tag: * @link * {@link $_encoding} setting. has been used a total of 2 times within the following files:
* [@param string Desired output encoding, see {@link set_parameter}]
This tag: * @link * [@param string Desired output encoding, see {@link set_parameter}] has been used a total of 2 times within the following files:
libraries/simplepie/idn/idna_convert.class.php: * [@param string Desired output encoding, see {@link set_parameter}] libraries/idna_convert/idna_convert.class.php: * [@param string Desired output encoding, see {@link set_parameter}]
// See {@link set_paramter()} for details of how to change the following
This tag: * @link // See {@link set_paramter()} for details of how to change the following has been used a total of 2 times within the following files:
libraries/simplepie/idn/idna_convert.class.php: // See {@link set_paramter()} for details of how to change the following libraries/idna_convert/idna_convert.class.php: // See {@link set_paramter()} for details of how to change the following
* You can select your preferred format via {@link set_paramter()}.
This tag: * @link * You can select your preferred format via {@link set_paramter()}. has been used a total of 2 times within the following files:
libraries/simplepie/idn/idna_convert.class.php: * You can select your preferred format via {@link set_paramter()}. libraries/idna_convert/idna_convert.class.php: * You can select your preferred format via {@link set_paramter()}.
* @param string $format The date format specification string (see {@link PHP_MANUAL#date})
This tag: * @link * @param string $format The date format specification string (see {@link PHP_MANUAL#date}) has been used a total of 2 times within the following files:
libraries/joomla/date/date.php: * @param string $format The date format specification string (see {@link PHP_MANUAL#date}) libraries/joomla/date/date.php: * @param string $format The date format specification string (see {@link PHP_MANUAL#date})
https://docs.joomla.org/JTable/move
This tag: * @link https://docs.joomla.org/JTable/move has been used a total of 2 times within the following files:
* Returns the global {@link JLanguage} object, only creating it if it doesn’t already exist.
This tag: * @link * Returns the global {@link JLanguage} object, only creating it if it doesn’t already exist. has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Returns the global {@link JLanguage} object, only creating it if it doesn't already exist.
* Returns the global {@link JCache} object
This tag: * @link * Returns the global {@link JCache} object has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Returns the global {@link JCache} object
* Returns the global {@link JDatabaseDriver} object, only creating it if it doesn’t already exist.
This tag: * @link * Returns the global {@link JDatabaseDriver} object, only creating it if it doesn’t already exist. has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Returns the global {@link JDatabaseDriver} object, only creating it if it doesn't already exist.
* Returns the global {@link JMail} object, only creating it if it doesn’t already exist.
This tag: * @link * Returns the global {@link JMail} object, only creating it if it doesn’t already exist. has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Returns the global {@link JMail} object, only creating it if it doesn't already exist.
* Returns the global {@link JAccess} object, only creating it
This tag: * @link * Returns the global {@link JAccess} object, only creating it has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Returns the global {@link JAccess} object, only creating it
* Returns the global {@link JSession} object, only creating it if it doesn’t already exist.
This tag: * @link * Returns the global {@link JSession} object, only creating it if it doesn’t already exist. has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Returns the global {@link JSession} object, only creating it if it doesn't already exist.
* Returns the global {@link JUser} object, only creating it if it doesn’t already exist.
This tag: * @link * Returns the global {@link JUser} object, only creating it if it doesn’t already exist. has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Returns the global {@link JUser} object, only creating it if it doesn't already exist.
* Returns the global {@link JDocument} object, only creating it if it doesn’t already exist.
This tag: * @link * Returns the global {@link JDocument} object, only creating it if it doesn’t already exist. has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Returns the global {@link JDocument} object, only creating it if it doesn't already exist.
https://docs.joomla.org/JTableAsset
This tag: * @link https://docs.joomla.org/JTableAsset has been used a total of 1 times within the following files:
* Returns the global {@link JApplicationCms} object, only creating it if it doesn’t already exist.
This tag: * @link * Returns the global {@link JApplicationCms} object, only creating it if it doesn’t already exist. has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Returns the global {@link JApplicationCms} object, only creating it if it doesn't already exist.
https://docs.joomla.org/JObserverInterface
This tag: * @link https://docs.joomla.org/JObserverInterface has been used a total of 1 times within the following files:
This tag: * @link * Return a reference to the {@link JUri} object has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Return a reference to the {@link JUri} object
* Returns the global {@link JRegistry} object, only creating it if it doesn’t already exist.
This tag: * @link * Returns the global {@link JRegistry} object, only creating it if it doesn’t already exist. has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Returns the global {@link JRegistry} object, only creating it if it doesn't already exist.
* was instantiated. Marks are strings as per {@link JProfiler::mark()}.
This tag: * @link * was instantiated. Marks are strings as per {@link JProfiler::mark()}. has been used a total of 1 times within the following files:
libraries/joomla/profiler/profiler.php: * was instantiated. Marks are strings as per {@link JProfiler::mark()}.
* @param string $type Return type for the variable, for valid values see {@link JFilterInput::clean()}.
This tag: * @link * @param string $type Return type for the variable, for valid values see {@link JFilterInput::clean()}. has been used a total of 1 times within the following files:
libraries/legacy/request/request.php: * @param string $type Return type for the variable, for valid values see {@link JFilterInput::clean()}.
@linkColor: #08c;
This tag: * @link @linkColor: #08c; has been used a total of 1 times within the following files:
media/jui/less/variables.less:@linkColor: #08c;
* @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
This tag: * @link * @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional. has been used a total of 1 times within the following files:
libraries/legacy/model/list.php: * @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
* Wrapper method for the {@link raise()} method with predefined error
This tag: * @link * Wrapper method for the {@link raise()} method with predefined error has been used a total of 1 times within the following files:
libraries/legacy/error/error.php: * Wrapper method for the {@link raise()} method with predefined error
* @param string $format The date format specification string (see {@link PHP_MANUAL#date}).
This tag: * @link * @param string $format The date format specification string (see {@link PHP_MANUAL#date}). has been used a total of 1 times within the following files:
libraries/cms/html/html.php: * @param string $format The date format specification string (see {@link PHP_MANUAL#date}).
* Wrapper method for the {@link raise()} method with predefined error level of E_WARNING and
This tag: * @link * Wrapper method for the {@link raise()} method with predefined error level of E_WARNING and has been used a total of 1 times within the following files:
libraries/legacy/error/error.php: * Wrapper method for the {@link raise()} method with predefined error level of E_WARNING and
@linkColorHover: darken(@linkColor, 15%);
This tag: * @link @linkColorHover: darken(@linkColor, 15%); has been used a total of 1 times within the following files:
https://msdn.microsoft.com/en-us/library/ms186819.aspx for more information
This tag: * @link https://msdn.microsoft.com/en-us/library/ms186819.aspx for more information has been used a total of 1 times within the following files:
libraries/joomla/database/query/sqlsrv.php: * @link https://msdn.microsoft.com/en-us/library/ms186819.aspx for more information
* Proxy for {@link FOFFormHelper::addHeaderPath()}.
This tag: * @link * Proxy for {@link FOFFormHelper::addHeaderPath()}. has been used a total of 1 times within the following files:
libraries/fof/form/form.php: * Proxy for {@link FOFFormHelper::addHeaderPath()}.
* @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
This tag: * @link * @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional. has been used a total of 1 times within the following files:
libraries/fof/model/model.php: * @param string $type Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
* Proxy for {@link FOFFormHelper::addFieldPath()}.
This tag: * @link * Proxy for {@link FOFFormHelper::addFieldPath()}. has been used a total of 1 times within the following files:
libraries/fof/form/form.php: * Proxy for {@link FOFFormHelper::addFieldPath()}.
* Proxy for {@link FOFFormHelper::loadRuleType()}.
This tag: * @link * Proxy for {@link FOFFormHelper::loadRuleType()}. has been used a total of 1 times within the following files:
libraries/fof/form/form.php: * Proxy for {@link FOFFormHelper::loadRuleType()}.
* Proxy for {@link FOFFormHelper::loadFieldType()}.
This tag: * @link * Proxy for {@link FOFFormHelper::loadFieldType()}. has been used a total of 1 times within the following files:
libraries/fof/form/form.php: * Proxy for {@link FOFFormHelper::loadFieldType()}.
* Proxy for {@link FOFFormHelper::loadHeaderType()}.
This tag: * @link * Proxy for {@link FOFFormHelper::loadHeaderType()}. has been used a total of 1 times within the following files:
libraries/fof/form/form.php: * Proxy for {@link FOFFormHelper::loadHeaderType()}.
* Return the {@link JDate} object
This tag: * @link * Return the {@link JDate} object has been used a total of 1 times within the following files:
libraries/joomla/factory.php: * Return the {@link JDate} object
https://docs.joomla.org/JTable/getAssetTitle
This tag: * @link https://docs.joomla.org/JTable/getAssetTitle has been used a total of 1 times within the following files:
https://simplepie.org/support/ Please submit all bug reports and feature requests to the SimplePie forums
This tag: * @link https://simplepie.org/support/ Please submit all bug reports and feature requests to the SimplePie forums has been used a total of 1 times within the following files:
libraries/simplepie/simplepie.php: * @link https://simplepie.org/support/ Please submit all bug reports and feature requests to the SimplePie forums
PHP version adapted from https://www.php.net/manual/en/function.quoted-printable-decode.php#89417
This tag: * @link PHP version adapted from https://www.php.net/manual/en/function.quoted-printable-decode.php#89417 has been used a total of 1 times within the following files:
libraries/phpmailer/phpmailer.php: * @link PHP version adapted from https://www.php.net/manual/en/function.quoted-printable-decode.php#89417
* @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
This tag: * @link * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. has been used a total of 1 times within the following files:
administrator/components/com_cache/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
* @param array|boolean $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}
This tag: * @link * @param array|boolean $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()} has been used a total of 1 times within the following files:
administrator/components/com_modules/controller.php: * @param array|boolean $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}
* {@link FinderIndexerHelper::$stemmer} object if it is set. If no stemmer is set,
This tag: * @link * {@link FinderIndexerHelper::$stemmer} object if it is set. If no stemmer is set, has been used a total of 1 times within the following files:
administrator/components/com_finder/helpers/indexer/helper.php: * {@link FinderIndexerHelper::$stemmer} object if it is set. If no stemmer is set,
* @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
This tag: * @link * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. has been used a total of 1 times within the following files:
administrator/components/com_menus/controllers/menus.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
* @param array|boolean $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
This tag: * @link * @param array|boolean $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. has been used a total of 1 times within the following files:
administrator/components/com_menus/controller.php: * @param array|boolean $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
* for valid values see {@link JFilterInput::clean()}. [optional]
This tag: * @link * for valid values see {@link JFilterInput::clean()}. [optional] has been used a total of 1 times within the following files:
components/com_finder/controller.php: * for valid values see {@link JFilterInput::clean()}. [optional]
* @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
This tag: * @link * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. has been used a total of 1 times within the following files:
components/com_tags/controller.php: * @param array An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
This tag: * @link https://sprain.ch/blog/downloads/php-class-easypeasyics-create-ical-files-with-php/ has been used a total of 1 times within the following files:
https://sourceforge.net/projects/phppatcher/ This has been derived from the PhpPatcher version 0.1.1 written by Giuseppe Mazzotta
This tag: * @link https://sourceforge.net/projects/phppatcher/ This has been derived from the PhpPatcher version 0.1.1 written by Giuseppe Mazzotta has been used a total of 1 times within the following files:
libraries/joomla/filesystem/patcher.php: * @link https://sourceforge.net/projects/phppatcher/ This has been derived from the PhpPatcher version 0.1.1 written by Giuseppe Mazzotta
https://docs.joomla.org/JTableNested
This tag: * @link https://docs.joomla.org/JTableNested has been used a total of 1 times within the following files:
* @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
This tag: * @link * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}. has been used a total of 1 times within the following files:
administrator/components/com_categories/controller.php: * @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.
https://docs.joomla.org/JTable/addIncludePath
This tag: * @link https://docs.joomla.org/JTable/addIncludePath has been used a total of 1 times within the following files:
Get web hosting that grows with your business. Our all-in-one hosting platform gives you everything your website needs to scale - so you can focus on the next big thing for you and your business.
