Elgg
Version 2.3
|
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) |
_elgg_entity_menu_setup | ( | $hook, | |
$type, | |||
$return, | |||
$params | |||
) |
Entity menu is list of links and info on any entity private.
Definition at line 468 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 577 of file navigation.php.
_elgg_nav_init | ( | ) |
Navigation initialization private.
Definition at line 603 of file navigation.php.
_elgg_nav_public_pages | ( | $hook_name, | |
$entity_type, | |||
$return_value, | |||
$params | |||
) |
Extend public pages.
string | $hook_name | "public_pages" |
string | $entity_type | "walled_garden" |
string[] | $return_value Paths accessible outside the "walled garden" | |
mixed | $params | unused |
Definition at line 641 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 428 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 343 of file navigation.php.
_elgg_widget_menu_setup | ( | $hook, | |
$type, | |||
$return, | |||
$params | |||
) |
Widget menu is a set of widget controls private.
Definition at line 526 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.
Definition at line 289 of file navigation.php.
elgg_get_menu_item | ( | $menu_name, | |
$item_name | |||
) |
Get a menu item registered for a menu.
string | $menu_name | The name of the menu |
string | $item_name | The unique identifier for this menu item |
Definition at line 186 of file navigation.php.
elgg_is_menu_item_registered | ( | $menu_name, | |
$item_name | |||
) |
Check if a menu item has been registered.
string | $menu_name | The name of the menu |
string | $item_name | The unique identifier for this menu item |
Definition at line 160 of file navigation.php.
elgg_pop_breadcrumb | ( | ) |
Removes last breadcrumb entry.
Definition at line 270 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.
string | $hook | "prepare" |
string | $type | "breadcrumbs" |
array | $breadcrumbs | Breadcrumbs to be altered |
array | $params | Hook parameters |
Definition at line 322 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.
string | $title | The title to display. During rendering this is HTML encoded. |
string | $link | Optional. The link for the title. During rendering links are normalized via elgg_normalize_url(). |
Definition at line 255 of file navigation.php.
elgg_register_menu_item | ( | $menu_name, | |
$menu_item | |||
) |
Register an item for an Elgg menu.
string | $menu_name | The name of the menu: site, page, userhover, userprofile, groupprofile, or any custom menu |
mixed | $menu_item | A 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 = do not create a link. null = current URL. "" = current URL. "/" = site home page. |
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.
Definition at line 97 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
string | $handler | The handler to use or null to autodetect from context |
string | $name | Name of the button (defaults to 'add') |
string | $entity_type | Optional entity type to be added (used to verify canWriteToContainer permission) |
string | $entity_subtype | Optional entity subtype to be added (used to verify canWriteToContainer permission) |
Definition at line 219 of file navigation.php.
elgg_unregister_menu_item | ( | $menu_name, | |
$item_name | |||
) |
Remove an item from a menu.
string | $menu_name | The name of the menu |
string | $item_name | The unique identifier for this menu item |
Definition at line 132 of file navigation.php.
return function(\Elgg\EventsService $events,\Elgg\HooksRegistrationService $hooks) |
Definition at line 649 of file navigation.php.