Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Namespaces | Functions | Variables
navigation.php File Reference

Go to the source code of this file.

Namespaces

 Elgg\Core
 Activate a plugin or plugins.
 

Functions

 elgg_register_menu_item ($menu_name, $menu_item)
 Register an item for an Elgg menu. More...
 
 elgg_unregister_menu_item ($menu_name, $item_name)
 Remove an item from a menu. More...
 
 elgg_is_menu_item_registered ($menu_name, $item_name)
 Check if a menu item has been registered. More...
 
 elgg_get_menu_item ($menu_name, $item_name)
 Get a menu item registered for a menu. More...
 
 elgg_register_title_button ($handler=null, $name= 'add', $entity_type= 'all', $entity_subtype= 'all')
 Convenience function for registering a button to the title menu. More...
 
 elgg_push_breadcrumb ($title, $link=null)
 Adds a breadcrumb to the breadcrumbs stack. More...
 
 elgg_pop_breadcrumb ()
 Removes last breadcrumb entry. More...
 
 elgg_get_breadcrumbs ()
 Returns all breadcrumbs as an array of array('title' => 'Title', 'link' => 'URL') More...
 
 elgg_prepare_breadcrumbs ($hook, $type, $breadcrumbs, $params)
 Prepare breadcrumbs before display. More...
 
 _elgg_site_menu_setup ($hook, $type, $return, $params)
 Set up the site menu. More...
 
 _elgg_river_menu_setup ($hook, $type, $return, $params)
 Add the comment and like links to river actions menu private. More...
 
 _elgg_entity_menu_setup ($hook, $type, $return, $params)
 Entity menu is list of links and info on any entity private. More...
 
 _elgg_widget_menu_setup ($hook, $type, $return, $params)
 Widget menu is a set of widget controls private. More...
 
 _elgg_login_menu_setup ($hook, $type, $return, $params)
 Add the register and forgot password links to login menu private. More...
 
 _elgg_nav_init ()
 Navigation initialization private. More...
 
 _elgg_nav_public_pages ($hook_name, $entity_type, $return_value, $params)
 Extend public pages. More...
 

Variables

return function (\Elgg\EventsService $events,\Elgg\HooksRegistrationService $hooks)
 

Function Documentation

_elgg_entity_menu_setup (   $hook,
  $type,
  $return,
  $params 
)

Entity menu is list of links and info on any entity private.

Definition at line 463 of file navigation.php.

_elgg_login_menu_setup (   $hook,
  $type,
  $return,
  $params 
)

Add the register and forgot password links to login menu private.

Definition at line 572 of file navigation.php.

_elgg_nav_init ( )

Navigation initialization private.

Definition at line 598 of file navigation.php.

_elgg_nav_public_pages (   $hook_name,
  $entity_type,
  $return_value,
  $params 
)

Extend public pages.

Parameters
string$hook_name"public_pages"
string$entity_type"walled_garden"
string[]$return_value Paths accessible outside the "walled garden"
mixed$paramsunused
Returns
string[] private
Since
1.11.0

Definition at line 636 of file navigation.php.

_elgg_river_menu_setup (   $hook,
  $type,
  $return,
  $params 
)

Add the comment and like links to river actions menu private.

Definition at line 423 of file navigation.php.

_elgg_site_menu_setup (   $hook,
  $type,
  $return,
  $params 
)

Set up the site menu.

Handles default, featured, and custom menu items

private

Definition at line 338 of file navigation.php.

_elgg_widget_menu_setup (   $hook,
  $type,
  $return,
  $params 
)

Widget menu is a set of widget controls private.

Definition at line 521 of file navigation.php.

elgg_get_breadcrumbs ( )

Returns all breadcrumbs as an array of array('title' => 'Title', 'link' => 'URL')

Since 1.11, breadcrumbs are filtered through the plugin hook [prepare, breadcrumbs] before being returned.

Returns
array Breadcrumbs
Since
1.8.0
See Also
elgg_prepare_breadcrumbs

Definition at line 284 of file navigation.php.

elgg_get_menu_item (   $menu_name,
  $item_name 
)

Get a menu item registered for a menu.

Parameters
string$menu_nameThe name of the menu
string$item_nameThe unique identifier for this menu item
Returns
ElggMenuItem|null
Since
1.9.0

Definition at line 181 of file navigation.php.

elgg_is_menu_item_registered (   $menu_name,
  $item_name 
)

Check if a menu item has been registered.

Parameters
string$menu_nameThe name of the menu
string$item_nameThe unique identifier for this menu item
Returns
bool
Since
1.8.0

Definition at line 155 of file navigation.php.

elgg_pop_breadcrumb ( )

Removes last breadcrumb entry.

Returns
array popped breadcrumb array or empty array
Since
1.8.0

Definition at line 265 of file navigation.php.

elgg_prepare_breadcrumbs (   $hook,
  $type,
  $breadcrumbs,
  $params 
)

Prepare breadcrumbs before display.

This turns titles into 100-character excerpts, and also removes the last crumb if it's not a link.

Parameters
string$hook"prepare"
string$type"breadcrumbs"
array$breadcrumbsBreadcrumbs to be altered
array$paramsHook parameters
Returns
array
Since
1.11

Definition at line 317 of file navigation.php.

elgg_push_breadcrumb (   $title,
  $link = null 
)

Adds a breadcrumb to the breadcrumbs stack.

See elgg_get_breadcrumbs() and the navigation/breadcrumbs view.

Parameters
string$titleThe title to display. During rendering this is HTML encoded.
string$linkOptional. The link for the title. During rendering links are normalized via elgg_normalize_url().
Returns
void
Since
1.8.0
See Also
elgg_get_breadcrumbs

Definition at line 250 of file navigation.php.

elgg_register_menu_item (   $menu_name,
  $menu_item 
)

Register an item for an Elgg menu.

Warning
Generally you should not use this in response to the plugin hook: 'register', 'menu:<menu_name>'. If you do, you may end up with many incorrect links on a dynamic menu.
A menu item's name must be unique per menu. If more than one menu item with the same name are registered, the last menu item takes priority.
See Also
elgg_view_menu() for the plugin hooks available for modifying a menu as it is being rendered.
ElggMenuItem::factory() is used to turn an array value of $menu_item into an ElggMenuItem object.
Parameters
string$menu_nameThe name of the menu: site, page, userhover, userprofile, groupprofile, or any custom menu
mixed$menu_itemA object or an array of options in format: name => STR Menu item identifier (required) text => STR Menu item display text as HTML (required) href => STR Menu item URL (required) (false for non-links.
Warning
If you disable the href the tag will not appear, so the link_class will not apply. If you put tags in manually through the 'text' option the default CSS selector .elgg-menu-$menu > li > a may affect formatting. Wrap in a if it does.) contexts => ARR Page context strings section => STR Menu section identifier title => STR Menu item tooltip selected => BOOL Is this menu item currently selected parent_name => STR Identifier of the parent menu item link_class => STR A class or classes for the tag item_class => STR A class or classes for the tag deps => STR One or more AMD modules to require

Additional options that the view output/url takes can be passed in the array. Custom options can be added by using the 'data' key with the value being an associative array.

Returns
bool False if the item could not be added
Since
1.8.0

Definition at line 93 of file navigation.php.

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

Convenience function for registering a button to the title menu.

The URL must be $handler/$name/$guid where $guid is the guid of the page owner. The label of the button is "$handler:$name" so that must be defined in a language file.

This is used primarily to support adding an add content button

Parameters
string$handlerThe handler to use or null to autodetect from context
string$nameName of the button (defaults to 'add')
string$entity_typeOptional entity type to be added (used to verify canWriteToContainer permission)
string$entity_subtypeOptional entity subtype to be added (used to verify canWriteToContainer permission)
Returns
void
Since
1.8.0

Definition at line 214 of file navigation.php.

elgg_unregister_menu_item (   $menu_name,
  $item_name 
)

Remove an item from a menu.

Parameters
string$menu_nameThe name of the menu
string$item_nameThe unique identifier for this menu item
Returns
|null
Since
1.8.0

Definition at line 127 of file navigation.php.

Variable Documentation

Definition at line 644 of file navigation.php.