Modul

From Joomla! Documentation

This page is a translated version of the page Module and the translation is 2% complete.

Other languages:
български • ‎català • ‎Deutsch • ‎English • ‎español • ‎français • ‎hrvatski • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎Nederlands • ‎português do Brasil • ‎Kiswahili

Modules are lightweight and flexible extensions used for page rendering. These modules are often “boxes” arranged around a component on a typical page. A well-known example is the login module. Modules are assigned per menu item, so you can decide to show or hide (for example) the login module depending on which page (menu item) the user is currently on. Some modules are linked to components: the “latest news” module, for example, links to the content component (com_content) and displays links to the newest content items. However, modules do not need to be linked to components; they don't even need to be linked to anything and can be just static HTML or text.

Modules are managed in the Joomla! Administrator view by the Module Manager. More information about module management can be found on the appropriate version help screens.

See also: Component, Plugin, Template

Learning More

Module Positions

A module position is a placeholder in a template. Placeholders identify one or several positions within the template and tell the Joomla! application where to place output from modules assigned to a particular position. The template designer has complete control over module positions, creating variations between templates and the respective Joomla! default positions assigned to modules in the installation sample data.

For example, the module position Left could be defined to be on the left side of the template to display a site navigation menu. So if a module is assigned the Left position, it will be displayed wherever the designer puts that Left module position - not necessarily the left side of the page.

Recommended Reading

Modules are one of the simplest parts of Joomla and a great entry point for people learning to use the system (the equivalent of widgets in wordpress). They can be displayed just about anywhere on a page (in all the positions a template allows as well as in the main content area using the loadmodule plugin for the com_content component).

Beginner

To understand how to install and use a module in Joomla it is recommended to read Module Manager. You can read also Module Manager Custom HTML for an example.

Beginner/Intermediate

Creating a simple module for Joomla is one of the simplest development steps you can do - and the creating a simple module tutorial is designed to take you through this. It starts with a simple module and then shows a few things you can then do with the module.

Advanced

Introduced into Joomla 3.2 is a hidden component that allows modules to create AJAX requests. You can find documentation about Using Joomla Ajax Interface to help you create even better modules.

Administrator Modules

Action Logs - Latest

This module shows a list of the most recent actions performed by your users on the Control Panel.

Module-ActionLogs-Latest-example-en.png

The Module Type name for this Module is "mod_latestactions". The Help Screen for this Module.

Administrator Menu

This Module shows the main admin navigation menu. An example of this module is shown below:

Admin-Menu-example-en.png

The Module Type name for this Module is "mod_menu". The Help Screen for this Module.

Administrator Sub-Menu

This Module shows the submenu navigation Module.

The Module Type name for this Module is "mod_submenu". The Help Screen for this Module.

Articles - Latest

This Module is used to display the "Recent added Articles" in the Control Panel. An example is shown below:

Admin-Latest-Articles-example-en.png

The Module Type name for this Module is "mod_latest". The Help Screen for this Module.

Custom

This module allows you to create your own module, using a WYSIWYG editor.

The Module Type name for this Module is "mod_custom". The Help Screen for this Module.

Feed Display

This Module allows you to show a news feed from an external web site. An example is shown below:

Admin-newsfeed-en.png

The Module Type name for this Module is "mod_feed". The Help Screen for this Module.

Joomla! Version Information

This Module shows the Joomla version used on the site.

The Module Type name for this Module is "mod_version". The Help Screen for this Module.

Logged-In Users

This Module shows a list of users who are currently logged into the site. This is displayed in the Control Panel. An example is shown below:

Logged-in-users-example-en.png

The Module Type name for this Module is "mod_logged". The Help Screen for this Module.

Login Form

This Module displays a Username and Password Login form. It should not be unpublished.

The Module Type name for this Module is "mod_login". The Help Screen for this Module.

Multilingual Status

This Module displays the multilingual status parameters of a site. Clicking on the 'multilingual status' link will display a modal like on this example:

Multilingual-Status-Module-example-en.png

The Module Type name for this Module is "mod_multilangstatus".
The module doesn't have specific settings. The Help Screen for this Module.

Popular Articles

This Module shows a list of the most popular articles, based on the number of hits. An example is shown below:

Admin-popular-articles-example-en.png

The Module Type name for this Module is "mod_popular". The Help Screen for this Module.

Privacy Dashboard

This Module shows information about privacy requests.

Module-Privacy-Dashboard-example-en.png

The Module Type name for this Module is "mod_privacy_dashboard".
The module doesn't have specific settings. The Help Screen for this Module.

Quick Icons

This module shows the Quick Icons on the Control Panel. An example is shown below:

Admin quick icons example-en.png

The Module Type name for this Module is "mod_quickicon".
The module doesn't have specific settings. The Help Screen for this Module.

Sample Data

This Module allows you to install the sample data.

The Module Type name for this Module is "mod_sampledata".
The module doesn't have specific settings.

Statistics

This Module shows information about your server and site information like the PHP and Database versions, OS used, number of articles, users, hits... An example is shown below:

Admin-Statistics-example-en.png

The Module Type name for this Module is "mod_stats". The Help Screen for this Module.

Title

This Module shows the Titles for each backend screen. An example is shown below:

Admin-Title-example-en.png

The Module Type name for this Module is "mod_title". The Help Screen for this Module.

Toolbar

This Module shows the toolbars used in the Joomla backend. An example is shown below:

Modules Site-Toolbar-example-en.png

The Module Type name for this Module is "mod_toolbar". The Help Screen for this Module.

User Status

This Module shows the User Status icons. This includes a Preview button, a link to open a new admin window, a Logout button, counts of Private Messages and current Logged-in Users and Logged-in Backend Users. An example is shown below.

User-status-example-en.png

The Module Type name for this Module is "mod_status". The Help Screen for this Module.

Site Modules

Joomla! is packaged with many modules, here are the standard modules available in a new Joomla! installation (more modules are available on the Joomla! Extension Directory).

Articles - Archived

This module shows a list of the calendar months containing archived articles. After you have changed the status of an article to archived, this list will be automatically generated.

The Module Type name for this Module is "mod_articles_archive". The Help Screen for this Module.

Articles - Categories

This module displays a list of categories from one parent category.

The Module Type name for this Module is "mod_articles_categories". The Help Screen for this Module.

Articles - Category

This module displays a list of articles from one or more categories.

The Module Type name for this Module is "mod_articles_category". The Help Screen for this Module.

Articles - Latest

This Module shows a list of the most recently published and current Articles. Some that are shown may have expired even though they are the most recent.

The Module Type name for this Module is "mod_articles_latest". The Help Screen for this Module.

Articles - Most Read

This Module shows a list of the currently published Articles which have the highest number of page views.

The Module Type name for this Module is "mod_articles_popular". The Help Screen for this Module.

Articles - Newsflash

The Newsflash Module will display a fixed number of articles from a specific category.

The Module Type name for this Module is "mod_articles_news". The Help Screen for this Module.

Articles - Related

This Module shows a list of Articles that are related to the current Article being viewed by the user (for example, a Article Layout or a Blog or List layout where the user has clicked on an Article link). Articles are considered to be related to each other if they share at least one Keyword in the Article's Metadata Information. Article Keywords are entered in the Metadata Information section of the Article Manager - New/Edit screen.

The Module Type name for this Module is "mod_related_items". The Help Screen for this Module.

Banners

The Banner Module displays the active Banners from the Component.

The Module Type name for this Module is "mod_banners". The Help Screen for this Module.

Breadcrumbs

This module shows a set of navigation links that illustrates where you are inside the web site and allows you to navigate back.

The Module Type name for this Module is "mod_breadcrumbs". The Help Screen for this Module.

Custom

The Custom Module allows you to create a self-contained HTML unit and then put it in any valid location on a page.

The Module Type name for this Module is "mod_custom". The Help Screen for this Module.

Feed Display

This Module shows an RSS News Feed from a website. This Module is not related to the News Feeds Component or the News Feeds Layouts and is an alternative that allows a feed to display in a Module position.

The Module Type name for this Module is "mod_feed". The Help Screen for this Module.

Footer

This Module displays the web site copyright and Joomla! license information.

The Module Type name for this Module is "mod_footer". The Help Screen for this Module.

Language Switcher

Text to translate This module allows you to switch between available Content languages. Selecting a language will take you to the home page for that language.

The Module Type name for this Module is "mod_languages". The Help Screen for this Module.

Latest Users

The Latest Users module will display the latest users which logged in at the website.

The Module Type name for this Module is "mod_users_latest". The Help Screen for this Module.

Login

This Module displays a username and password Login form. It also displays a link to retrieve a forgotten password. If User registration is enabled in the Users Configuration screen, then the link "Create an Account" will be shown to invite Users to self-register.

The Module Type name for this Module is "mod_login". The Help Screen for this Module.

Menu

This module displays a menu on the Frontend.

The Module Type name for this Module is "mod_menu". The Help Screen for this Module.

Random Image

This Module displays a random image from your chosen directory.

The Module Type name for this Module is "mod_random_image". The Help Screen for this Module.

Search

This module will display a search box.

The Module Type name for this Module is "mod_search". The Help Screen for this Module.

Smart Search

Smart Search is an enhanced site search.

The Module Type name for this Module is "mod_finder". The Help Screen for this Module.

Statistics

This Module shows information about your server and site information like the PHP and Database versions, OS used, number of articles, users, hits...

The Module Type name for this Module is "mod_stats". The Help Screen for this Module.

Syndication Feeds

Smart Syndication Module that creates a Syndicated Feed for the page where the Module is displayed.

The Module Type name for this Module is "mod_syndicate". The Help Screen for this Module.

Tags - Popular

This module displays tags used on the site in a list or a cloud layout. Tags can be ordered by title or by the number of tagged items and limited to a specific time period.

The Module Type name for this Module is "mod_tags_popular". The Help Screen for this Module.

Tags - Similar

The Similar Tags Module displays links to other items with similar tags. The closeness of the match can be specified.

The Module Type name for this Module is "mod_tags_similar". The Help Screen for this Module.

Who's Online

The Who's Online Module displays the number of Anonymous Users (e.g. Guests) and Registered Users (ones logged-in) that are currently accessing the website.

The Module Type name for this Module is "mod_whosonline". The Help Screen for this Module.

Wrapper

This module shows an iFrame window to specified location.

The Module Type name for this Module is "mod_wrapper". The Help Screen for this Module.