backend_marketing_promos
Позволяет модифицировать и добавлять дополнительное содержимое на страницу со списком промоакций в разделе «Маркетинг».
Доступно начиная с версии 8.5.0.
Shop-Script
Входящие параметры (передаются по ссылке)
$params['show_unatt_storefronts'] bool Флаг, означающий, показан ли в интерфейсе элемент для отображения промоакций, не связанных ни с одной витриной.
$params['unattached_active'] bool Флаг, означающий, выбран ли в данный момент элемент для отображения промоакций, не связанных ни с одной витриной.
$params['active_promos'] array Список активных промоакций. Каждый элемент списка — массив со следующими ключами:
$params['active_promos'][promo_id]['id'] int ID промоакции.
$params['active_promos'][promo_id]['name'] int ID промоакции.
$params['active_promos'][promo_id]['enabled'] bool Флаг, означающий статус промоакции.
$params['active_promos'][promo_id]['start_datetime'] datetime|null Дата и время начала действия промоакции.
$params['active_promos'][promo_id]['finish_datetime'] datetime|null Дата и время окончания действия промоакции.
$params['active_promos'][promo_id]['author_contact_id'] int|null ID пользователя, создавшего промоакцию. Или
$params['active_promos'][promo_id]['create_datetime'] datetime|null Дата и время создания промоакции. Или
$params['active_promos'][promo_id]['update_datetime'] datetime|null Дата и время последнего обновления свойств промоакции.
$params['active_promos'][promo_id]['image'] string|null Относительный URL изображения баннера промоакции.
$params['active_promos'][promo_id]['color'] string|null Цвет текста, выбранный в настройках баннера промоакции.
$params['active_promos'][promo_id]['background_color'] string|null Цвет фона, выбранный в настройках баннера промоакции.
$params['active_promos'][promo_id]['period_percent'] float|null Степень завершения промоакции в процентах в зависимости от дат её создания, начала и окончания.
$params['planned_promos'] array Информация о запланированных промоакциях в таком же формате, как описано для ключа
$params['completed_promos'] array Информация о завершённых промоакциях в таком же формате, как описано для ключа
$params['promos_charts'] array Список значений для формирования графиков статистики промоакций. Каждый элемент списка — массив со следующими ключами:
$params['promos_charts'][promo_id]['date'] date Дата для отображения значения графика.
$params['promos_charts'][promo_id]['value'] float Значение для отображения на графике.
$params['promos_markers'] array Список данных об инструментах, включённых в настройках промоакций. Каждый элемент списка — список инструментов промоакции. Каждый элемент списка инструментов — массив со следующими ключами:
$params['promos_markers'][promo_id][tool_id]['type'] string Обозначение типа инструмента.
$params['promos_markers'][promo_id][tool_id]['name'] string Локализованное название инструмента.
$params['promos_markers'][promo_id][tool_id]['css_class'] string CSS-класс для отображения иконки инструмента в интерфейсе.
$params['promos_markers'][promo_id][tool_id]['max_count'] int Максимальное количество экземпляров инструмента, допустимое в настройках промоакции.
$params['promos_stats'] array Данные статистики выполнения промоакций.
$params['promos_stats'][promo_id]['promo_id'] int ID промоакции.
$params['promos_stats'][promo_id]['orders_count'] int Количество заказов.
$params['promos_stats'][promo_id]['sales'] float Размер выручки.
$params['promos_stats'][promo_id]['profit'] float Размер прибыли.
$params['promos_stats'][promo_id]['expenses'] float Размер затрат на маркетинг.
$params['promos_stats'][promo_id]['paid_for_itself'] bool Флаг, означающий окупившуюся промоакцию.
$params['promos_stats'][promo_id]['roi'] float|null Показатель ROI.
$params['storefronts'] array Список всех витрин магазина.
$params['filtering'] array Параметры фильтрации списка промоакций.
$params['filtering']['storefront'] string|null Выбранная витрина.
$params['filtering']['status'] string|null Выбранный статус промоакций:
$params['filtering']['page'] int Номер страницы при просмотре длинного списка промоакций.
$params['unattached_active'] bool Флаг, означающий, выбран ли в данный момент элемент для отображения промоакций, не связанных ни с одной витриной.
$params['active_promos'] array Список активных промоакций. Каждый элемент списка — массив со следующими ключами:
$params['active_promos'][promo_id]['id'] int ID промоакции.
$params['active_promos'][promo_id]['name'] int ID промоакции.
$params['active_promos'][promo_id]['enabled'] bool Флаг, означающий статус промоакции.
$params['active_promos'][promo_id]['start_datetime'] datetime|null Дата и время начала действия промоакции.
$params['active_promos'][promo_id]['finish_datetime'] datetime|null Дата и время окончания действия промоакции.
$params['active_promos'][promo_id]['author_contact_id'] int|null ID пользователя, создавшего промоакцию. Или
NULL, если промоакция была создана автоматически во время установки Shop-Script.$params['active_promos'][promo_id]['create_datetime'] datetime|null Дата и время создания промоакции. Или
NULL, если промоакция была создана автоматически во время установки Shop-Script.$params['active_promos'][promo_id]['update_datetime'] datetime|null Дата и время последнего обновления свойств промоакции.
$params['active_promos'][promo_id]['image'] string|null Относительный URL изображения баннера промоакции.
$params['active_promos'][promo_id]['color'] string|null Цвет текста, выбранный в настройках баннера промоакции.
$params['active_promos'][promo_id]['background_color'] string|null Цвет фона, выбранный в настройках баннера промоакции.
$params['active_promos'][promo_id]['period_percent'] float|null Степень завершения промоакции в процентах в зависимости от дат её создания, начала и окончания.
$params['planned_promos'] array Информация о запланированных промоакциях в таком же формате, как описано для ключа
active_promos.$params['completed_promos'] array Информация о завершённых промоакциях в таком же формате, как описано для ключа
active_promos.$params['promos_charts'] array Список значений для формирования графиков статистики промоакций. Каждый элемент списка — массив со следующими ключами:
$params['promos_charts'][promo_id]['date'] date Дата для отображения значения графика.
$params['promos_charts'][promo_id]['value'] float Значение для отображения на графике.
$params['promos_markers'] array Список данных об инструментах, включённых в настройках промоакций. Каждый элемент списка — список инструментов промоакции. Каждый элемент списка инструментов — массив со следующими ключами:
$params['promos_markers'][promo_id][tool_id]['type'] string Обозначение типа инструмента.
$params['promos_markers'][promo_id][tool_id]['name'] string Локализованное название инструмента.
$params['promos_markers'][promo_id][tool_id]['css_class'] string CSS-класс для отображения иконки инструмента в интерфейсе.
$params['promos_markers'][promo_id][tool_id]['max_count'] int Максимальное количество экземпляров инструмента, допустимое в настройках промоакции.
$params['promos_stats'] array Данные статистики выполнения промоакций.
$params['promos_stats'][promo_id]['promo_id'] int ID промоакции.
$params['promos_stats'][promo_id]['orders_count'] int Количество заказов.
$params['promos_stats'][promo_id]['sales'] float Размер выручки.
$params['promos_stats'][promo_id]['profit'] float Размер прибыли.
$params['promos_stats'][promo_id]['expenses'] float Размер затрат на маркетинг.
$params['promos_stats'][promo_id]['paid_for_itself'] bool Флаг, означающий окупившуюся промоакцию.
$params['promos_stats'][promo_id]['roi'] float|null Показатель ROI.
$params['storefronts'] array Список всех витрин магазина.
$params['filtering'] array Параметры фильтрации списка промоакций.
$params['filtering']['storefront'] string|null Выбранная витрина.
$params['filtering']['status'] string|null Выбранный статус промоакций:
'planned' (запланированные), 'active' (активные), 'completed' (завершённые).$params['filtering']['page'] int Номер страницы при просмотре длинного списка промоакций.
… код плагина …
Результат работы плагина
{$backend_marketing_promos.action_link}
Дополнительное содержимое рядом со ссылками для выполнения действий с промоакциями. Например, HTML-код ссылок дополнительных действий.
{$backend_marketing_promos.bottom}
Дополнительное содержимое в нижней части страницы со списком промоакций. Например, блок с информацией или фрагмент JavaScript-кода.
Shop-Script
Пример кода плагина
PHP
public function backendMarketingPromos($params)
{
$page = $params['filtering']['page'];
return [
'action_link' => '<a href="">' . _wp('My plugin’s action link') . '</a>',
'bottom' => '<div class="box highlighted custom-p-8">' . sprintf_wp('Current page No. is %d.', $page) . '</div>',
];
}
