Документация для разработчиков

Новости (комплексный компонент)

Комплексный компонент позволяет создать новостной раздел на сайте. Доступен просмотр детальной информации, списка элементов, настройка экспорта в rss, организация голосования за новости (или другие элементы инфоблоков), настройка отзывов, вывода материалов по темам, настройки ЧПУ и многое другое. Компонент содержит 3 шаблона: .default, web20 и flat. Компонент стандартный и входит в дистрибутив модуля.

В визуальном редакторе компонент расположен по пути: Контент > Статьи и новости > Новости.

Компонент относится к модулю Информационные блоки.

Пример вызова компонента news

Секции настроек компонента:

  • Управление адресами страниц
  • Управление режимом AJAX
  • Основные параметры
  • Настройки RSS
  • Настройки голосования
  • Настройка материалов по теме
  • Настройки отзывов
  • Настройки фильтра
  • Источник данных
  • Настройки списка
  • Настройка детального просмотра
  • Настройки постраничной навигации детального просмотра
  • Дополнительные настройки
  • Настройки кеширования
  • Настройки постраничной навигации
  • Настройки 404 ошибки
  • Описание параметров

    Поле Параметр Описание
    Управление адресами страниц
    Включить поддержку ЧПУ SEF_MODE [Y|N] При отмеченной опции будет включена поддержка ЧПУ.

    Если режим поддержки ЧПУ включен, то необходимо настроить следующие параметры: Настраиваемые параметры при включенном режиме поддержки ЧПУ:
    Каталог ЧПУ (относительно корня сайта)SEF_FOLDER Каталог ЧПУ: путь до папки, с которой работает компонент. Этот путь может как совпадать с физическим путём, так и не совпадать. Все остальные настройки из этой секции дописываются к каталогу ЧПУ.
    Адреса страниц SEF_URL_TEMPLATES Указываются адреса следующих страниц:
    • news - страница общего списка;
    • section - страница раздела;
    • detail - страница детального просмотра;
    SEF_FOLDER, SEF_URL_TEMPLATES.

    Если режим поддержки ЧПУ выключен, то необходимо настроить следующие параметры: Настраиваемые параметры при выключенном режиме поддержки ЧПУ:
    Идентификатор раздела SECTION_ID Указывается идентификатор раздела.
    Идентификатор новости ELEMENT_ID Указывается идентификатор новости.
    SECTION_ID, ELEMENT_ID.
    Имена переменных VARIABLE_ALIASES Имена переменных для управления страницами.
    Управление режимом AJAX
    Включить режим AJAX AJAX_MODE [Y|N] При установленной опции для компонента будет включен режим AJAX.
    Включить прокрутку к началу компонента AJAX_OPTION_JUMP [Y|N] Если пользователь совершит AJAX-переход, то при установленой опции по окончании загрузки произойдет прокрутка к началу компонента.
    Включить подгрузку стилей AJAX_OPTION_STYLE [Y|N] Если параметр принимает значение "Y", то при совершении AJAX-переходов будет происходить подгрузка и обработка списка стилей, вызванных компонентом.
    Включить эмуляцию навигации браузера AJAX_OPTION_HISTORY [Y|N] Когда пользователь выполняет AJAX-переходы, то при включенной опции можно использовать кнопки браузера "Назад" и "Вперед".
    Основные параметры
    Тип инфо-блока IBLOCK_TYPE Указывается один из созданных в системе типов информационного блока. Выбрав пункт (другое)->, можно указать вручную ID информационного блока.
    Инфо-блок IBLOCK_ID Для выбранного типа инфоблока указывается идентификатор информационного блока, новости из которого будут выводиться.
    Количество новостей на странице NEWS_COUNT Указывается количество новостей, отображаемых на одной странице.
    Разрешить поиск USE_SEARCH [Y|N] При отмеченной опции будет выведена форма поиска. Поиск будет осуществляться только в выводимой данным компонентом информации.
    Настройки RSS
    Разрешить RSS USE_RSS [Y|N] При отмеченной опции будет разрешен экспорт в RSS и доступны поля Доступные поля:
    Количество новостей для экспорта NUM_NEWS Задается количество новостей для экспорта.
    Количество дней для экспорта NUM_DAYS Указывается количество дней для экспорта новостей.
    Экспортировать в диалект Яндекса YANDEX [Y|N] При отмеченной опции новости будут экспортироваться в диалект Яндекса.
    для спецификации настроек RSS: NUM_NEWS, NUM_DAYS и YANDEX.
    Настройки голосования
    Разрешить голосование USE_RATING [Y|N] При отмеченной опции посетители смогут голосовать за новости, выставляя баллы, на странице с детальной информацией. При установленной опции становятся доступными следующие поля: Доступные поля:
    Максимальный балл MAX_VOTE Указывается максимально возможный балл, т.е. число возможных оценок.
    Подписи к баллам VOTE_NAMES Указываются подписи к каждому баллу. В коде вводится массив, в котором задаются подписи к баллам в таком виде:
    "VOTE_NAMES" => Array("0","1","2","3","4","5"),
    Если подписи заданы, то они будут выведены вместо оценок-цифр. Если массив не задан, то будут использованы значения по умолчанию.
    MAX_VOTE и VOTE_NAMES.
    Настройка материалов по теме
    Выводить материалы по теме USE_CATEGORIES [Y|N] При отмеченной опции будут выводиться материалы по теме и станут доступны дополнительные поля: Доступные поля:
    Инфоблоки CATEGORY_IBLOCK Указываются инфоблоки, из которых будет происходить выборка информации. В коде задается в виде массива:
    array(0=>"33",1=>"29",2=>"8",),
    Код свойства CATEGORY_CODE Указывается код свойства, в котором хранится привязка элемента к определенному разделу (например, THEMES).
    Максимальное количество материалов из одного инфоблока CATEGORY_ITEMS_COUNT Указывается максимальное количество материалов (элементов), которое можно выбрать из одного инфоблока.
    Стиль вывода материалов из инфоблока CATEGORY_THEME Выбирается один из двух стилей вывода:
    • в виде списка
    • предпросмотр картинок
    Материалы в привязке к темам создаются следующим образом:
    • создается инфоблок (например, Темы), в котором определяются будущие темы материалов в виде разделов (разделы заполнять элементами не требуется);
    • в настройках инфоблока, элементы которого предполагается привязывать к созданным темам, определятся свойство типа Привязка к разделам и выбирается инфоблок, в котором разделы являются темами;
    • для каждого из элементов этого инфоблока задается свойство привязки к теме.
    Настройки отзывов
    Разрешить отзывы USE_REVIEW [Y|N] При отмеченной опции будет доступен функционал отзывов. Функционал отзывов:
    Количество сообщений на одной странице MESSAGES_PER_PAGE Параметр определяет количество выводимых на одной странице сообщений.
    Использовать CAPTCHA USE_CAPTCHA [Y|N] При отмеченной опции будет выводиться изображение и поле ввода CAPTCHA в форме добавления отзыва в публичной части.
    Использовать AJAX в диалогах REVIEW_AJAX_POST [Y|N] При отмеченной опции будет разрешено использование AJAX.
    Путь относительно корня сайта к папке со смайлами PATH_TO_SMILE Задается путь к папке со смайликами относительно корня сайта.
    ID форума для отзывов FORUM_ID Указывается идентификатор форума, в котором будут храниться отзывы пользователей.
    Страница чтения темы (пусто - получить из настроек форума) URL_TEMPLATES_READ Указывается относительный путь к странице чтения темы на форуме. Если поле пусто, путь к странице будет получен из настроек форума.
    Показать ссылку на форум SHOW_LINK_TO_FORUM [Y|N] При отмеченной опции на странице новости будет отображена ссылка на форум обсуждения.
    Начинать тему текстом элемента POST_FIRST_MESSAGE [Y|N] При отмеченной опции сообщение в отзыве будет начинаться с анонса новости.
    Настройки фильтра
    Показывать фильтр USE_FILTER [Y|N] При отмеченной опции становятся доступными поля настройки фильтра. Поля настройки фильтра:
    Фильтр FILTER_NAME Указывается имя переменной, в которой передается массив параметров из фильтра. Служит для определения выходящих из фильтра элементов. Если поле оставлено пустым, то используется значение по умолчанию.
    Поля FILTER_FIELD_CODE Указываются поля, которые будут отображены на странице списка элементов. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
    Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
    При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже (т.е. если задан пустой массив), на странице списка будут выведены поля по умолчанию.
    Свойства FILTER_PROPERTY_CODE Указываются свойства, которые будут отображены на странице списка элементов. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив. При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже, на странице детального просмотра свойства не будут выведены.
    Источник данных
    Поле для первой сортировки новостей SORT_BY1 Поле для первой сортировки новостей:
    • ID – по идентификатору;
    • NAME – по заголовку;
    • ACTIVE_FROM – по дате начала активности;
    • SORT – по индексу сортировки;
    • TIMESTAMP_X – по дате последнего изменения.
    Выбрав пункт (другое)->, в поле рядом можно указать код нужного поля.
    Направление для первой сортировки новостей SORT_ORDER1 Задается направление для первой сортировки новостей:
    • ASCПо возрастанию;
    • DESCПо убыванию.
    Поле для второй сортировки новостей SORT_BY2 Поле для второй сортировки новостей:
    • ID – по идентификатору;
    • NAME – по заголовку;
    • ACTIVE_FORM – по дате начала активности;
    • SORT – по индексу сортировки;
    • TIMESTAMP_X – по дате последнего изменения.
    Выбрав пункт (другое)->, в поле рядом можно указать код нужного поля.
    Направление для второй сортировки новостей SORT_ORDER2 Задается направление для второй сортировки новостей:
    • ASCПо возрастанию;
    • DESCПо убыванию.
    Показывать только активные на данный момент элементы CHECK_DATES [Y|N] При отмеченной опции будут показаны только активные на данный момент элементы.
    Настройки списка
    Максимальная длина анонса для вывода (только для типа текст) PREVIEW_TRUNCATE_LEN Указывается максимальная длина анонса для вывода (только для типа текст). При превышении параметра остаток текста будет отсечен.
    Формат показа даты LIST_ACTIVE_DATE_FORMAT Указывается формат показа даты. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
    Поля LIST_FIELD_CODE Указываются поля, которые будут отображены на странице списка элементов. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
    Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
    При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже (т.е. если задан пустой массив), на странице списка будут выведены поля по умолчанию.
    Свойства LIST_PROPERTY_CODE Указываются свойства, которые будут отображены на странице списка элементов. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив. При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже, на странице детального просмотра свойства не будут выведены.
    Скрывать ссылку, если нет детального описания HIDE_LINK_WHEN_NO_DETAIL [Y|N] При отмеченной опции ссылки будут скрыты, если нет детальной информации или у пользователя нет прав на ее просмотр.
    Управление адресами страниц
    Выводить название элемента DISPLAY_NAME [Y|N] При отмеченной опции будет выводиться название элемента.
    Установить ключевые слова страницы из свойства META_KEYWORDS Среди всех свойств, определенных для данного инфоблока, выбирается то, в котором содержатся ключевые слова.
    Установить описание страницы из свойства META_DESCRIPTION Среди всех свойств, определенных для данного инфоблока, выбирается то, в котором содержится описание.
    Установить заголовок окна браузера из свойства BROWSER_TITLE Среди всех свойств, определенных для данного инфоблока, выбирается то, которое будет выводиться в заголовоке окна браузера.
    Устанавливать канонический URLDETAIL_SET_CANONICAL_URL[Y|N] При отмеченной опции страница новости будет помечена как каноническая (т.е. будет считаться основной для поисковых систем среди ее дублей).

    Каноническая ссылка строится для основного раздела элемента, а если он не задан, то для раздела с наименьшим идентификатором.
    Формат показа даты DETAIL_ACTIVE_DATE_FORMAT Указывается формат показа даты. В выпадающем списке перечислены все возможные варианты показа даты, формируемые внутри компонента. Выбрав пункт (другое)->, можно сформировать свой вариант на основании php-функции date.
    Поля FIELD_CODE Указываются поля, которые будут отображены на странице детального просмотра. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив:
    Array("NAME","PREVIEW_TEXT","PREVIEW_PICTURE","DETAIL_TEXT",""),
    При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже (т.е. если задан пустой массив), на странице списка будут выведены поля по умолчанию.
    Свойства PROPERTY_CODE Указываются свойства, которые будут отображены на странице детального просмотра. Заполняется из публичной части редактора, удерживая клавишу Ctrl либо в коде, указывая массив. При выборе пункта (не выбрано)-> и без указания вычисления полей в строках ниже, на странице детального просмотра свойства не будут выведены.
    Настройки постраничной навигации детального просмотра
    Название шаблона DETAIL_PAGER_TEMPLATE Указывается название шаблона постраничной навигации детального просмотра. При необходимости можно указать шаблон кодом в поле ниже.
    Выводить над списком DETAIL_DISPLAY_TOP_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена вверху страницы детального просмотра.
    Выводить под списком DETAIL_DISPLAY_BOTTOM_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена внизу страницы детального просмотра.
    Название категорий DETAIL_PAGER_TITLE Задается название категорий, по которым происходит перемещение при детальном просмотре (например, страница, глава и др.).
    Дополнительные настройки
    Устанавливать в заголовках ответа время модификации страницыSET_LAST_MODIFIED[Y|N] При отмеченной опции http-ответ сервера будет содержать время последнего изменения страницы (заголовок Last-Modified).
    Устанавливать заголовок страницы SET_TITLE [Y|N] При отмеченной опции в качестве заголовка страницы будет установлено имя текущего раздела.
    Включать инфоблок в цепочку навигации INCLUDE_IBLOCK_INTO_CHAIN [Y|N] При отмеченной опции в цепочку навигации будет добавлено имя инфоблока.
    Включать раздел в цепочку навигации ADD_SECTIONS_CHAIN [Y|N] При отмеченной опции при переходе по разделам ифоблока в цепочку навигации будут добавлены названия или заголовки (если заданы в настройках SEO) разделов.
    Включать название элемента в цепочку навигации ADD_ELEMENT_CHAIN [Y|N] При отмеченной опции название или заголовок (если задан в настройках SEO) элемента будет добавлен в цепочку навигации.
    Использовать дополнительное ограничение доступа USE_PERMISSIONS [Y|N] При отмеченной опции Станет активным поле Группы пользователей, имеющие доступ к детальной информации.
    Группы пользователей, имеющие доступ к детальной информации GROUP_PERMISSIONS Указываются группы пользователей, имеющие доступ к детальной информации.
    будет ограничен доступ к детальной информации элементов инфоблока.
    Строгая проверка раздела STRICT_SECTION_CHECK [Y|N] При отмеченной опции будет выполняться строгая проверка принадлежности элемента к разделу. Таким образом, если при просмотре элемента в адресной строке указать неверный раздел, то будет выдана 404-я ошибка.
    Если опцию не отмечать, то нужный элемент будет показан в любом случае.
    Выводить дату элемента DISPLAY_DATE [Y|N] При отмеченной опции будут выведены даты элементов.
    Выводить изображение для анонса DISPLAY_PICTURE [Y|N] При отмеченной опции для элемента будут выведены изображения (анонс и детальная картинка), если они заданы. Если флаг снят, то никакое изображение показано не будет.
    Выводить текст анонса DISPLAY_PREVIEW_TEXT [Y|N] При отмеченной опции будет выведен текст анонса для элементов, если он определен.
    В качестве рейтинга показывать* DISPLAY_AS_RATINGУказывается одно из значений, которое должно быть показано в качестве рейтинга:
    • Рейтинг (rating);
    • Среднее значение (vote_avg).
    Количество тегов* TAGS_CLOUD_ELEMENTSУказывается количество тегов, отображаемых в облаке.
    Период, в течение которого считать тег новым (дней)* PERIOD_NEW_TAGSУказывается период (количество дней), в течение которого тег считается новым.
    Максимальный размер шрифта (px)* FONT_MAXУказывается максимальный размер шрифта отображения тегов (в пикселах).
    Минимальный размер шрифта (px)* FONT_MINУказывается минимальный размер шрифта отображения тегов (в пикселах).
    Цвет более позднего тега (пример: "C0C0C0")* COLOR_NEWУказывается код цвета тегов, дата создания которых наиболее поздняя (пример: "C0C0C0").
    Цвет более раннего тега (пример: "FEFEFE")* COLOR_OLDУказывается код цвета тегов, дата создания которых наиболее ранняя (пример: "FEFEFE").
    Ширина облака тегов (пример: "100%" или "100px", "100pt", "100in")* TAGS_CLOUD_WIDTHУказывается ширина облака тегов (пример: "100%" или "100px", "100pt", "100in").
    Отображать панель соц. закладок USE_SHAREРазрешает отображение панели закладок соцсетей при детальном просмотре новости.При выбранной опции становятся активными дополнительные поля. Дополнительные поля:
    Используемые соц. закладки и сети SHARE_HANDLERSВыбор сетей, которые будут отображаться в закладке соцсетей.
    Логин для bit.ly SHARE_SHORTEN_URL_LOGINЛогин для сервиса сокращений.
    Ключ для для bit.ly SHARE_SHORTEN_URL_KEYПароль для сервиса сокращений.
    Не раскрывать панель соц. закладок по умолчанию SHARE_HIDEЕсли опция выбрана, то список соц сетей будет свёрнута под общим значком.
    Шаблон компонента панели соц. закладок SHARE_TEMPLATEУказывается имя шаблона, если используется не системный шаблон.
    Свойство с изображениями для слайдера** SLIDER_PROPERTYУказывается свойство, которые будет использовано для показа картинок в слайдере.
    * - поля, доступные для шаблона web20.
    ** - поля, доступные для шаблона flat.
    Настройки кеширования
    Тип кеширования CACHE_TYPE Тип кеширования:
    • A - Авто + Управляемое: автоматически обновляет кеш компонентов в течение заданного времени или при изменении данных;
    • Y - Кешировать: для кеширования необходимо определить время кеширования;
    • N - Не кешировать: кеширования нет в любом случае.
    Время кеширования (сек.) CACHE_TIME Время кеширования, указанное в секундах.
    Кэшировать при установленном фильтре CACHE_FILTER [Y|N] При отмеченной опции каждый результат, полученный из фильтра, будет кешироваться.
    Учитывать права доступа CACHE_GROUPS [Y|N] При отмеченной опции будут учитываться права доступа при кешировании.
    Настройка детального просмотра
    Выводить над списком DISPLAY_TOP_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена вверху страницы, над списком.
    Выводить под списком DISPLAY_BOTTOM_PAGER [Y|N] При отмеченной опции постраничная навигация будет выведена внизу страницы, под списком.
    Название категорий PAGER_TITLE Задается название категорий, по которым происходит перемещение при детальном просмотре (например, страница, глава и др.).
    Выводить всегда PAGER_SHOW_ALWAYS [Y|N] При отмеченной опции постраничная навигация будет выводиться всегда. По умолчанию выключено.
    Название шаблона PAGER_TEMPLATE Указывается название шаблона постраничной навигации.
    Использовать обратную навигацию PAGER_DESC_NUMBERING [Y|N] При отмеченной опции будет использоваться обратная навигация. Для обратной навигации в системе происходит обратный отсчет страниц (последняя страница считается первой). Таким образом, постоянно меняется лишь последняя страница при добавлении нового элемента. Это верно, если новые элементы попадают всегда вверх списка (отсортированы по дате начала активности по убыванию).
    Время кеширования страниц для обратной навигации PAGER_DESC_NUMBERING_CACHE_TIME Задается время кеширования страниц для обратной навигации.
    Показывать ссылку "Все" PAGER_SHOW_ALL [Y|N] При отмеченной опции в постраничную навигацию будет добавлена ссылка Все, с помощью которой можно отобразить все новости. По умолчанию выключено.
    Включить обработку ссылокPAGER_BASE_LINK_ENABLE[Y|N] При отмеченной опции доступна обработка ссылок для постраничной навигации. Станут активны дополнительные поля. Дополнительные поля:
    Url для построения ссылок (по умолчанию - автоматически)PAGER_BASE_LINKЗадается адрес для построения ссылок. Если в параметре ничего не указывать, то адрес будет построен автоматически.
    Имя массива с переменными для построения ссылок в постраничной навигацииPAGER_PARAMS_NAMEЗадается имя переменной, в которой передается массив с переменными для построения ссылок компонентом постраничной навигации.
    Настройки 404 ошибки
    Устанавливать статус 404SET_STATUS_404[Y|N] Опция служит для включения обработки ошибки 404 в компоненте.
    Показ специальной страницыSHOW_404[Y|N] При отмеченной опции будет показана специальная страница Станет активным поле:
    Страница для показа (по умолчанию /404.php)FILE_404Задается адрес страницы, которая будет отображаться при возникновении ошибки 404.
    в случае возникновения ошибки 404, в противном случае - будет отображено специальное сообщение. Станет активным поле:
    Сообщение для показа (по умолчанию из компонента)MESSAGE_404Задается сообщение, которое будет показано в случае возникновения ошибки 404. Если ничего не указывать, то будет использоваться стандартное сообщение из компонента.


    Пользовательские комментарии

    Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

    Для этого нужно всего лишь авторизоваться на сайте

    Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

    Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
    © «Битрикс», 2001-2019, «1С-Битрикс», 2019
    Наверх