Functions you should be familiar with
This page is up to date for Elgg 1.8.
Until we have a maintainable way to link directly to function documentation, just grep for the function in the Elgg source code to learn more about it (always in engine/lib).
You might also be interested in the printable version!
Plugin Initialization
- elgg_extend_view
- elgg_register_simplecache_view
- elgg_get_simplecache_url
- elgg_load_js
- elgg_register_js
- elgg_unregister_js
- elgg_load_css
- elgg_register_css
- elgg_unregister_css
- elgg_load_library
- elgg_register_library
- elgg_unregister_library
- elgg_register_event_handler
- elgg_trigger_event_handler
- elgg_unregister_event_handler
- elgg_register_plugin_hook_handler
- elgg_trigger_plugin_hook_handler
- elgg_unregister_plugin_hook_handler
- elgg_register_entity_url_handler
- elgg_register_entity_type
- elgg_register_tag_metadata_name
- elgg_register_widget_type
- elgg_unregister_widget_type
- elgg_register_viewtype_fallback
- add_subtype
- update_subtype
see engine/lib/elgglib.php
Actions, Input, Forms
- elgg_register_action
- elgg_is_xhr
- elgg_clear_sticky_value
- elgg_get_sticky_value
- elgg_get_sticky_values
- elgg_is_sticky_form
- elgg_make_sticky_form
- elgg_clear_sticky_form
- elgg_view_form
- get_input
- set_input
- forward
- register_error
- system_message
see engine/lib/actions.php
- elgg_pop_breadcrumb
- elgg_push_breadcrumb
- elgg_register_menu_item
- elgg_unregister_menu_item
- elgg_register_admin_menu_item
- elgg_view_menu
see engine/lib/navigation.php
Viewing Data
- elgg_view_entity
- elgg_list_annotations
- elgg_list_entities
- elgg_list_entities_from_annotations
- elgg_list_entities_from_metadata
- elgg_list_entities_from_relationship
- elgg_view
- elgg_view_comments
- elgg_view_entity_icon
- elgg_view_friendly_time
- elgg_view_icon
- elgg_view_image_block
- elgg_view_module
- elgg_view_tagcloud
Fetching Data
- get_entity
- elgg_get_entities
- elgg_get_entities_from_annotations
- elgg_get_entities_from_metadata
- elgg_get_entities_from_relationship
- elgg_get_annotations
- elgg_get_metadata
- elgg_get_tags
Page handling, context
- elgg_view_layout
- elgg_view_page
- elgg_get_context
- elgg_set_context
- elgg_in_context
- elgg_push_context
- elgg_pop_context
- elgg_get_page_owner_entity
- elgg_get_page_owner_guid
- elgg_set_page_owner_guid
see engine/lib/pagehandler.php
Settings / Configuration
- elgg_get_plugin_setting
- elgg_get_plugin_user_setting
- elgg_is_active_plugin
- elgg_get_site_url
- elgg_get_plugins_path
- elgg_get_root_dir
- elgg_set_config
- elgg_get_config
see engine/lib/plugins.php
Relationships
- add_entity_relationship
- remove_entity_relationship
- check_entity_relationship
River
- add_to_river
- elgg_get_river
- elgg_list_river
see engine/lib/river.php
Permissions
- gatekeeper
- group_gatekeeper
- elgg_get_logged_in_user_entity
- elgg_get_logged_in_user_guid
- elgg_is_admin_logged_in
- elgg_is_logged_in
Misc
- elgg_extract
- elgg_echo
- elgg_get_friendly_title
- elgg_get_friendly_time
- elgg_view_exists
- string_to_tag_array
