navigation.php

Go to the documentation of this file.

<?php
function elgg_register_menu_item($menu_name, $menu_item) {
    if (is_array($menu_item)) {
        $options = $menu_item;
        $menu_item = ElggMenuItem::factory($options);
        if (!$menu_item instanceof ElggMenuItem) {
            $menu_item_name = elgg_extract('name', $options, 'MISSING NAME');
            elgg_log("Unable to add menu item '{$menu_item_name}' to '$menu_name' menu", 'WARNING');
            return false;
        }
    }

    if (!$menu_item instanceof ElggMenuItem) {
        elgg_log('Second argument of elgg_register_menu_item() must be an instance of '
            . 'ElggMenuItem or an array of menu item factory options', 'ERROR');
        return false;
    }

    $menus = _elgg_services()->config->menus;
    if (empty($menus)) {
        $menus = [];
    }

    $menus[$menu_name][] = $menu_item;
    _elgg_services()->config->menus = $menus;

    return true;
}

function elgg_unregister_menu_item($menu_name, $item_name) {
    $menus = _elgg_services()->config->menus;
    if (empty($menus)) {
        return null;
    }
    
    if (!isset($menus[$menu_name])) {
        return null;
    }

    foreach ($menus[$menu_name] as $index => $menu_object) {
        /* @var \ElggMenuItem $menu_object */
        if ($menu_object instanceof ElggMenuItem && $menu_object->getName() == $item_name) {
            $item = $menus[$menu_name][$index];
            unset($menus[$menu_name][$index]);
            elgg_set_config('menus', $menus);
            return $item;
        }
    }

    return null;
}

function elgg_register_title_button($handler = null, $name = 'add', $entity_type = '', $entity_subtype = '') {

    $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 (empty($href) && isset($handler)) {
        elgg_deprecated_notice('Using handler for fallback HREF determination is no longer supported in ' . __METHOD__, '4.0');
    }
    
    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',
    ]);
}