navigation.php

Go to the documentation of this file.

<?php
function elgg_register_menu_item(string $menu_name, array|\ElggMenuItem $menu_item): void {
    if (is_array($menu_item)) {
        $menu_item = \ElggMenuItem::factory($menu_item);
    }
    
    _elgg_services()->menus->registerMenuItem($menu_name, $menu_item);
}

function elgg_unregister_menu_item(string $menu_name, string $item_name): ?\ElggMenuItem {
    return _elgg_services()->menus->unregisterMenuItem($menu_name, $item_name);
}

function elgg_register_title_button(string $name = 'add', string $entity_type = '', string $entity_subtype = ''): void {

    $owner = elgg_get_page_owner_entity();
    if (!$owner) {
        // noone owns the page so this is probably an all site list page
        $owner = elgg_get_logged_in_user_entity();
    }
    
    if ($name === 'add' && $owner instanceof \ElggUser) {
        // make sure the add link goes to the current logged in user, not the page owner
        $logged_in_user = elgg_get_logged_in_user_entity();
        if (!empty($logged_in_user) && ($logged_in_user->guid !== $owner->guid)) {
            // change the 'owner' for the link to the current logged in user
            $owner = $logged_in_user;
        }
    }
    
    // do we have an owner and is the current user allowed to create content here
    if (!$owner instanceof \ElggEntity || empty($entity_type) || empty($entity_subtype) || !$owner->canWriteToContainer(0, $entity_type, $entity_subtype)) {
        return;
    }
    
    $href = elgg_generate_url("{$name}:{$entity_type}:{$entity_subtype}", [
        'guid' => $owner->guid,
    ]);
    
    if (elgg_language_key_exists("{$name}:{$entity_type}:{$entity_subtype}")) {
        $text = elgg_echo("{$name}:{$entity_type}:{$entity_subtype}");
    } else {
        $text = elgg_echo($name);
    }
    
    // register the title menu item
    elgg_register_menu_item('title', [
        'name' => $name,
        'icon' => $name === 'add' ? 'plus' : '',
        'href' => $href,
        'text' => $text,
        'link_class' => 'elgg-button elgg-button-action',
    ]);
}