Portal hooks

Light Portal es maravillosamente extensible gracias a los plugins. Los Hooks permiten que los plugins interactúen con varios componentes del portal.

Hooks básicos

init

redefiniendo variables $txt , ejecutando ganchos SMF, etc.

php

public function init(): void
{
    /* call integrate_actions hook */
    $this->applyHook('actions');
}

/* integrate_actions hook */
public function actions(): void
{
    if ($this->request()->is(LP_ACTION) && $this->request()->has('turbo')) {
        $this->showXml();
    }
}

parseContent

analizando contenido de tipos de bloque/página personalizados

php

public function parseContent(Event $e): void
{
    $e->args->content = Content::parse($e->args->content, 'html');
}

prepareContent

añadir contenido personalizado de tu plugin

php

public function prepareContent(Event $e): void
{
    $this->setTemplate();

    $userData = $this->cache($this->name . '_addon_u' . Utils::$context['user']['id'])
        ->setLifeTime($e->args->cacheTime)
        ->setFallback(self::class, 'getData');

    show_user_info($userData);
}

prepareEditor

añadir cualquier código en el área de edición de bloque/página

php

public function prepareEditor(Event $e): void
{
    if ($e->args->object['type'] !== 'markdown')
        return;

    Lang::load('Editor');

    Theme::loadCSSFile('https://cdn.jsdelivr.net/npm/easymde@2/dist/easymde.min.css', ['external' => true]);

    Theme::addInlineCss('
    .editor-toolbar button {
        box-shadow: none;
    }');
}

preloadStyles

ayuda a precargar las hojas de estilo que necesita

PHPHTML

php

public function preloadStyles(Event $e): void
{
    $e->args->styles[] = 'https://cdn.jsdelivr.net/npm/@flaticon/flaticon-uicons@1/css/all/all.css';
}

html

<link
  rel="preload"
  href="https://cdn.jsdelivr.net/npm/@flaticon/flaticon-uicons@1/css/all/all.css"
  as="style"
  onload="this.onload=null;this.rel='stylesheet'"
/>

Trabajar con bloques

prepareBlockParams

añadir parámetros de bloque

php

public function prepareBlockParams(Event $e): void
{
    $e->args->params = [
        'body_class'     => 'descbox',
        'display_type'   => 0,
        'include_topics' => '',
        'include_pages'  => '',
        'seek_images'    => false,
    ];
}

validateBlockParams

añadir reglas de validación personalizadas al añadir o editar bloques

php

public function validateBlockParams(Event $e): void
{
    $e->args->params = [
        'body_class'     => FILTER_DEFAULT,
        'display_type'   => FILTER_VALIDATE_INT,
        'include_topics' => FILTER_DEFAULT,
        'include_pages'  => FILTER_DEFAULT,
        'seek_images'    => FILTER_VALIDATE_BOOLEAN,
    ];
}

findBlockErrors

añadir manejo de errores personalizado al añadir o editar bloque

php

public function findBlockErrors(Event $e): void
{
    if ($e->args->data['placement'] !== 'ads')
        return;

    Lang::$txt['lp_post_error_no_ads_placement'] = $this->txt['no_ads_placement'];

    if (empty($e->args->data['parameters']['ads_placement'])) {
        $e->args->errors[] = 'no_ads_placement';
    }
}

prepareBlockFields

añadir campos personalizados al área de post del bloque

php

public function prepareBlockFields(Event $e): void
{
    RadioField::make('display_type', $this->txt['display_type'])
        ->setTab(BlockArea::TAB_CONTENT)
        ->setOptions($this->txt['display_type_set'])
        ->setValue($e->args->options['display_type']);

    CheckboxField::make('seek_images', $this->txt['seek_images'])
        ->setValue($e->args->options['seek_images']);
}

onBlockSaving

acciones personalizadas al guardar/editar bloques

onBlockRemoving

acciones personalizadas al eliminar bloques

php

public function onBlockRemoving(Event $e): void
{
    foreach ($e->args->items as $item) {
        $this->cache()->forget('block_' . $item . '_cache');
    }
}

Trabajar con páginas

preparePageParams

añadiendo parámetros de la página

php

public function preparePageParams(Event $e): void
{
    $e->args->params['meta_robots'] = '';
    $e->args->params['meta_rating'] = '';
}

validatePageParams

añadir reglas de validación personalizadas al añadir o editar página

php

public function validatePageParams(Event $e): void
{
    $e->args->params['meta_robots'] = FILTER_DEFAULT;
    $e->args->params['meta_rating'] = FILTER_DEFAULT;
}

findPageErrors

añadir gestión de errores personalizada al añadir o editar la página

preparePageFields

añadir campos personalizados al área de publicación de la página

php

public function preparePageFields(Event $e): void
{
    VirtualSelectField::make('meta_robots', $this->txt['meta_robots'])
        ->setTab(PageArea::TAB_SEO)
        ->setOptions(array_combine($this->meta_robots, $this->txt['meta_robots_set']))
        ->setValue($e->args->options['meta_robots']);
}

onPageSaving

acciones personalizadas al guardar/editar páginas

onCustomPageImport

custom actions on custom page import

php

public function onCustomPageImport(Event $e): void
{
    $e->args->items = array_map(function ($item) {
        $item['title'] = Utils::$smcFunc['htmlspecialchars']($item['title']);

        return $item;
    }, $e->args->items);
}

onPageRemoving

acciones personalizadas al eliminar páginas

php

public function onPageRemoving(Event $e): void
{
    foreach ($e->args->items as $item) {
        $this->cache()->forget('page_' . $item . '_cache');
    }
}

preparePageData

preparación adicional de los datos de la página actual del portal

php

public function preparePageData(Event $e): void
{
    $this->setTemplate()->withLayer('ads_placement_page');
}

beforePageContent

capacidad para mostrar algo antes del contenido de la página del portal

afterPageContent

capacidad para mostrar algo después del contenido de la página del portal

comments

añadir script de comentario personalizado a la vista de página actual del portal

php

public function comments(): void
{
    if (! empty(Config::$modSettings['lp_show_comment_block']) && Config::$modSettings['lp_show_comment_block'] === 'disqus' && ! empty($this->context['shortname'])) {
        Utils::$context['lp_disqus_comment_block'] = '
            <div id="disqus_thread" class="windowbg"></div>
            <script>
                <!-- Your code -->
            </script>';
    }
}

commentButtons

añadir botones personalizados debajo de cada comentario

php

public function commentButtons(Event $e): void
{
    if (empty(Utils::$context['lp_page']['options']['allow_reactions']))
        return;

    $comment = $e->args->comment;

    $comment['can_react'] = $comment['poster']['id'] !== User::$info['id'];
    $comment['reactions'] = json_decode($comment['params']['reactions'] ?? '', true) ?? [];
    $comment['prepared_reactions'] = $this->getReactionsWithCount($comment['reactions']);
    $comment['prepared_buttons'] = json_decode($comment['prepared_reactions'], true);

    ob_start();

    show_comment_reactions($comment);

    $e->args->buttons[] = ob_get_clean();
}

Trabajar con plugins

addSettings

añadir ajustes personalizados de su plugin

php

public function addSettings(Event $e): void
{
    $this->addDefaultValues(['some_color' => '#ff00ad']);

    $e->args->settings[$this->name] = SettingsFactory::make()
        ->text('some_text')
        ->check('some_check')
        ->int('some_int', ['min' => 1])
        ->select('some_select', [1, 2, 3])
        ->color('some_color')
        ->range('some_range', ['max' => 10])
        ->toArray();
}

saveSettings

acciones adicionales después de guardar la configuración del plugin

php

public function saveSettings(Event $e): void
{
    $this->cache()->flush();
}

prepareAssets

guardar estilos externos, scripts e imágenes para mejorar la velocidad de carga de recursos

php

public function prepareAssets(Event $e): void
{
    $builder = new AssetBuilder($this);
    $builder->scripts()->add('https://cdn.jsdelivr.net/npm/apexcharts@3/dist/apexcharts.min.js');
    $builder->css()->add('https://cdn.jsdelivr.net/npm/apexcharts@3/dist/apexcharts.min.css');
    $builder->appendTo($e->args->assets);
}

Trabajar con artículos

frontModes

añadir modos personalizados para la página principal

php

public function frontModes(Event $e): void
{
    $$e->args->modes[$this->mode] = CustomArticle::class;

    $e->args->currentMode = $this->mode;
}

frontLayouts

añadir lógica personalizada en la página principal

php

public function frontLayouts(Event $e): void
{
    if (! str_contains($e->args->layout, $this->extension))
        return;

    $e->args->renderer = new LatteRenderer();
}

layoutExtensions

permite añadir extensiones de diseño personalizado

php

public function layoutExtensions(Event $e): void
{
    $e->args->extensions[] = '.twig';
}

frontAssets

añadir scripts y estilos personalizados en la página principal

php

public function frontAssets(): void
{
    $this->loadExternalResources([
        ['type' => 'css', 'url' => 'https://cdn.example.com/custom.css'],
        ['type' => 'js',  'url' => 'https://cdn.example.com/custom.js'],
    ]);
}

frontTopics

añadir columnas personalizadas, tablas, donde, parámetros y órdenes a la función init

php

public function frontTopics(Event $e): void
{
    $e->args->wheres[] = ['t.num_replies > ?' => 1];
}

frontTopicsRow

varias manipulaciones con resultados de consultas a la función getData

php

public function frontTopicsRow(Event $e): void
{
    $e->args->articles[$e->args->row['id_topic']]['replies'] = $e->args->row['num_replies'] ?? 0;
}

frontPages

adding custom columns, joins, where conditions, params and orders to init function

php

public function frontPages(Event $e): void
{
    $e->args->joins[] = fn(Select $select) => $select->join(
        ['lc' => 'lp_comments'],
        'lp.page_id = lc.page_id',
        ['num_comments'],
        Select::JOIN_LEFT
    );

    $e->args->wheres[] = ['lc.approved' => 1];
}

frontPagesRow

varias manipulaciones con resultados de consultas a la función getData

php

public function frontPagesRow(Event $e): void
{
    $e->args->articles[$e->args->row['id']]['comments'] = $e->args->row['num_comments'] ?? 0;
}

frontBoards

añadir columnas personalizadas, tablas, donde, parámetros y órdenes a la función init

php

public function frontBoards(Event $e): void
{
    $e->args->columns['num_topics'] = new Expression('MIN(b.num_topics)');

    $e->args->wheres[] = fn(Select $select) => $select->where->greaterThan('b.num_topics', 5);
}

frontBoardsRow

varias manipulaciones con resultados de consultas a la función getData

php

public function frontBoardsRow(Event $e): void
{
    $e->args->articles[$e->args->row['id_board']]['custom_field'] = 'value';
}

Trabajar con iconos

prepareIconList

añadir lista personalizada de iconos (en lugar de FontAwesome)

php

public function prepareIconList(Event $e): void
{
    if (($mainIcons = $this->cache()->get('all_main_icons', 30 * 24 * 60 * 60)) === null) {
        $set = $this->getIconSet();

        $mainIcons = [];
        foreach ($set as $icon) {
            $mainIcons[] = $this->prefix . $icon;
        }

        $this->cache()->put('all_main_icons', $mainIcons, 30 * 24 * 60 * 60);
    }

    $$e->args->icons = array_merge($$e->args->icons, $mainIcons);
}

prepareIconTemplate

añadir plantilla personalizada para mostrar iconos

php

public function prepareIconTemplate(Event $e): void
{
    $e->args->template = "<i class=\"custom-class {$e->args->icon}\" aria-hidden=\"true\"></i>";
}

changeIconSet

habilidad para extender los iconos de la interfaz disponibles a través de Utils::$context['lp_icon_set'] array

php

public function changeIconSet(Event $e): void
{
    $e->args->set['snowman'] = 'fa-solid fa-snowman';
}

Configuración del portal

extendBasicConfig

añadir configuraciones personalizadas en el área de configuración básica del portal

php

public function extendBasicConfig(Event $e): void
{
    $e->args->configVars[] = ['text', 'option_key', 'subtext' => $this->txt['my_mod_description']];
}

extendAdminAreas

añadiendo las áreas personalizadas del portal en el Centro de Administración

php

public function extendAdminAreas(Event $e): void
{
    if (User::$info['is_admin']) {
        $e->args->areas['lp_pages']['subsections']['import_from_ep'] = [
            Utils::$context['lp_icon_set']['import'] . $this->txt['label_name']
        ];
    }
}

extendBlockAreas

añadir pestañas personalizadas en la configuración del área de bloque

php

public function extendBlockAreas(Event $e): void
{
    $e->args->areas['import_from_tp'] = [new BlockImport(), 'main'];
}

extendPageAreas

añadiendo pestañas personalizadas en la configuración del área de página

php

public function extendPageAreas(Event $e): void
{
    $e->args->areas['import_from_ep'] = [new Import(), 'main'];
}

extendCategoryAreas

añadiendo pestañas personalizadas en la configuración del área de categoría

php

public function extendCategoryAreas(Event $e): void
{
    $e->args->areas['import_from_tp'] = [new Import(), 'main'];
}

extendTagAreas

añadiendo pestañas personalizadas en la configuración del área de Tag

extendPluginAreas

añadiendo pestañas personalizadas en la configuración del área de plugins

php

public function extendPluginAreas(Event $e): void
{
    $e->args->areas['add'] = [new Handler(), 'add'];
}

Varios

credits

añadir derechos de autor de bibliotecas/scripts usados, etc.

php

public function credits(Event $e): void
{
    $e->args->links[] = [
        'title' => 'Uicons',
        'link' => 'https://www.flaticon.com/uicons',
        'author' => 'Flaticon',
        'license' => [
            'name' => 'ISC License',
            'link' => 'https://www.freepikcompany.com/legal#nav-flaticon-agreement'
        ]
    ];
}

downloadRequest

handling download requests for portal attachments

php

public function downloadRequest(Event $e): void
{
    if ($e->args->attachRequest['id'] === (int) $this->request()->get('attach')) {
        // Some handling
    }
}

Portal hooks ​

Hooks básicos ​

init ​

parseContent ​

prepareContent ​

prepareEditor ​

preloadStyles ​

Trabajar con bloques ​

prepareBlockParams ​

validateBlockParams ​

findBlockErrors ​

prepareBlockFields ​

onBlockSaving ​

onBlockRemoving ​

Trabajar con páginas ​

preparePageParams ​

validatePageParams ​

findPageErrors ​

preparePageFields ​

onPageSaving ​

onCustomPageImport ​

onPageRemoving ​

preparePageData ​

beforePageContent ​

afterPageContent ​

comments ​

commentButtons ​

Trabajar con plugins ​

addSettings ​

saveSettings ​

prepareAssets ​

Trabajar con artículos ​

frontModes ​

frontLayouts ​

layoutExtensions ​

frontAssets ​

frontTopics ​

frontTopicsRow ​

frontPages ​

frontPagesRow ​

frontBoards ​

frontBoardsRow ​

Trabajar con iconos ​

prepareIconList ​

prepareIconTemplate ​

changeIconSet ​

Configuración del portal ​

extendBasicConfig ​

extendAdminAreas ​

extendBlockAreas ​

extendPageAreas ​

extendCategoryAreas ​

extendTagAreas ​

extendPluginAreas ​

Varios ​

credits ​

downloadRequest ​

Portal hooks

Hooks básicos

init

parseContent

prepareContent

prepareEditor

preloadStyles

Trabajar con bloques

prepareBlockParams

validateBlockParams

findBlockErrors

prepareBlockFields

onBlockSaving

onBlockRemoving

Trabajar con páginas

preparePageParams

validatePageParams

findPageErrors

preparePageFields

onPageSaving

onCustomPageImport

onPageRemoving

preparePageData

beforePageContent

afterPageContent

comments

commentButtons

Trabajar con plugins

addSettings

saveSettings

prepareAssets

Trabajar con artículos

frontModes

frontLayouts

layoutExtensions

frontAssets

frontTopics

frontTopicsRow

frontPages

frontPagesRow

frontBoards

frontBoardsRow

Trabajar con iconos

prepareIconList

prepareIconTemplate

changeIconSet

Configuración del portal

extendBasicConfig

extendAdminAreas

extendBlockAreas

extendPageAreas

extendCategoryAreas

extendTagAreas

extendPluginAreas

Varios

credits

downloadRequest