Вставка модуля Joomla в код шаблона или компонента

Для того, чтобы вставить работающий код php в любое место программного кода Joomla или в шаблон сайта или адмики, можно использовать прямую вставку php-кода или же, если требуется вставлять однотипные куски кода, можно их подружать из файлов, расположенных на сервере. Как сделать последнее подробно описано в → этой статье. Однако, изменение кода компонентов Joomla и/или её шаблонов связано с расходом времени на доступ до необходимых файлов, иногда расположенных вне зоны доступа из админки. В этой статье рассмотрим, как вставить модуль Joomla в код шаблона или компонента. Это позволит при необходимости быстро вносить требуемые правки через Менеджер модулей в админке Joomla.

Предварительная подготовка к вставке модуля Joomla в код шаблона или компонента

Для того, чтобы вставить модуль Joomla в код шаблона или компонента стандартными средствами CMS, требуется задать его позицию. Использовать стандартные позиции шаблона не всегда удобно, — они могут быть заняты под нужды шаблона. Поэтому первым делом нужно задать новую позицию в файле конфигурации шаблона templateDetails.xml. О том, как это сделать подробно описано → в этой статье.

После того, как позиция модуля прописана в файле конфигурации шаблона templateDetails.xml нужно присвоить её модулю. Как это сделать в админке можно прочитать → по этой ссылке.

Теперь, когда у модуля есть собственная позиция, его можно вызвать в любом месте программного кода Joomla.

Код для вставки модуля Joomla в шаблон или компонент

Код для вставки модуля Joomla в шаблон или компонент выглядит следующим образом:

jimport( 'joomla.application.module.helper' );
$module = JModuleHelper::getModules('position-N');
$attribs['style'] = 'none';
echo JModuleHelper::renderModule($module[0], $attribs);

Первая строчка jimport( 'joomla.application.module.helper' ); вызывает подключение класса module.helper. Она требуется лишь в том случае, если этот класс не был подключен ранее. Нет смысла в повторных определениях. Самым простым способом определить это — использовать код вызова модуля без это строчки.

Вторая строчка $module = JModuleHelper::getModules('position-N'); передаёт переменной $module заполняем массив модулей, опубликованных в позиции position-N.

Третья строчка $attribs['style'] = 'none'; может принимать два значения:

1. указываем стиль вывода модуля 'none' если не нужно выводить заголовок модуля;
2. указываем стиль вывода модуля 'xhtml', если нужно вывести заголовок и его отображение включено в настройках модуля в админке.

Четвёртая строчка echo JModuleHelper::renderModule($moduleUp[0], $attribs); выдаёт первый модуль из этой позиции.

Как вариант, можно не сразу выдавать этот модуль, а передать его в переменную. А затем переменную вывести в нужном месте кода:

$moduleN = JModuleHelper::renderModule($moduleUp[0], $attribs);

Есть ещё вариант, когда нужно вывести все модули из заданной позиции, тогда нужно использовать цикл для перебора всех значений массива $module:

foreach($modules as $module){
echo JModuleHelper::renderModule($module, $attribs);
}

Если требуется вывести только определённые модули из позиции position-N, нужно указать номер расположения модуля в этом массиве при его вызове $moduleUp[N] в первом случае, или ввести условия при переборе элементов массива в цикле во втором случае.

Резюме

Таким образом, парой строчек кода можно управлять выводом модулей в практически любом месте шаблона или компонента Joomla 3. При этом не требуется создавать никаких дополнительных файлов для хранения php-кода. Модули, как наверное понятно всем, хранятся в базе данных сайта и управляются стандартными средствами через админку Joomla.

Заберите ссылку на статью к себе, чтобы потом легко её найти!
Раз уж досюда дочитали, то может может есть желание рассказать об этом месте своим друзьям, знакомым и просто мимо проходящим?
Не надо себя сдерживать! ;)