Functions

Primary tabs

Contains filters are case sensitive
Namesort ascending Location Description
menu_execute_page_request includes/menu.inc
menu_convert_replacement_pattern includes/menu.inc Look for modules implementing hook_menu_handle_replacement_pattern, and apply to str.
menu_check_user_access includes/menu.inc Looks at the router item's details (from menu_get_item) and returns TRUE or FALSE if the user can access this item.
l includes/misc.inc This works like Drupal's l() function for creating links. Ex: l("Click here for course search!", "tools/course-search", "abc=xyz&hello=goodbye", array("class" => "my-class")); Do not…
invoke_hook includes/misc.inc Invoke all module hooks for the supplied hook.
install_perform_install ./install.php Actually performs the installation of FlightPath
install_get_settings_file_template ./install.php Returns a template for a new settings file.
install_display_requirements ./install.php Displays the requirements on screen for the user.
install_display_lang_selection ./install.php
install_display_db_form ./install.php Displays the form to let a user set up a new database
install_check_requirements ./install.php Check for missing requirements of the system.
include_module_install includes/misc.inc Find and include the module's .install file, if it exists. Returns TRUE or FALSE if it was able to find & include the file.
include_module includes/misc.inc This will find and include the module in question, calling it's hook_init() function if it has one.
hook_validate includes/hook.api.php Validates form submissions from the Form API
hook_user_login includes/hook.api.php Perform actions when the user logs in successfully.
hook_update includes/hook.api.php Handle needed database updates when user updates a module.
hook_uninstall includes/hook.api.php This hook will be executed when a module is "uninstalled" in the system. Once a module is disabled, an "uninstall" link will appear.
hook_translate includes/hook.api.php This function is called by the t() function, and gives modules a chance to intercept a string and change it. Meant primarily for translating to another language, but also good for simple replacements. Used by the Locale module.
hook_theme_pie_charts includes/hook.api.php Similar to other theme functions, this function will take an array which describes *all* the pie charts, and allow another module to act on them.
hook_theme_advise_group_select_row includes/hook.api.php Similar to hook_theme_advise_course_row. This lets the user theme the "select X hours..." row for a group.
hook_theme_advise_footnote includes/hook.api.php This function allowes the user to theme footnotes before they are draw onto the screen.
hook_theme_advise_degree_header_row includes/hook.api.php This hook allows another module to alter the way a "degree header" row is drawn onto the advising screen.
hook_theme_advise_course_row includes/hook.api.php This hook allows another module to alter the way a course row is drawn onto the advising screen.
hook_submit includes/hook.api.php Handle submissions from the Form API
hook_student_load includes/hook.api.php Allows modules to hook in after a new student object is created.
hook_status includes/hook.api.php Reports status information which each module is aware of, visible on admin/config/status.
hook_save_advising_session_from_post includes/hook.api.php This hook allows modules to perform extra functions just after an advising session is saved by the system.
hook_save_advising_session includes/hook.api.php This hook allows modules to perform extra functions just after an advising session is saved by the system.
hook_render_block modules/blocks/blocks.module Example of hook_render_block
hook_perm includes/hook.api.php This hook defines available permissions for a module. These perms are used with hook_menu() and the function user_has_permission()
hook_menu_handle_replacement_pattern includes/hook.api.php This hook is called by the menu system. It allows each module the change to replace string patterns in its menu items (defined in hook_menu).
hook_menu_alter includes/hook.api.php This hook lets us make alterations to menu items before saving them to the database.
hook_menu includes/hook.api.php Allows modules to specify valid URLs in FlightPath, and define what function to call when the user visits that URL.
hook_install includes/hook.api.php This hook will be executed the first time a module is enabled in the system.
hook_init includes/hook.api.php Allows each module to execute code when the module is first loaded.
hook_group_load includes/hook.api.php Allows modules to act after a group object has been loaded.
hook_fp_get_student_majors includes/hook.api.php Returns a full listing of the student's majors.
hook_form_alter includes/hook.api.php Alter forms which are created using the Form API
hook_flightpath_can_assign_course_to_group includes/hook.api.php Is the course allowed to be assigned to the specified group? Returns TRUE or FALSE. $group should be a fully formed Group object.
hook_flightpath_can_assign_course_to_degree_id includes/hook.api.php Is the course allowed to be assigned to the specified degree? Returns TRUE or FALSE
hook_exit includes/hook.api.php Allows each module to execute code when the FlightPath page is completely finished.
hook_enable includes/hook.api.php This hook will be executed when a module is enabled in the system. It will be executed AFTER hook_install.
hook_disable includes/hook.api.php This hook will be executed when a module is disabled in the system.
hook_degree_plan_load includes/hook.api.php Allows modules to hook in after a degree plan object is created & loaded.
hook_cron includes/hook.api.php This hook is called every time the system cron is run.
hook_course_load includes/hook.api.php Allows modules to act after a course object has been loaded.
hook_courselist_find_match_allow_course includes/hook.api.php This hook his called just before returning a Course object from CourseList::find_best_grade_match or find_most_recent_match.
hook_content_register_content_type modules/content/content.module Sample hook other modules implement to register a content type.
hook_content_load modules/content/content.module Sample hook for hook_content_load
hook_content_alter includes/hook.api.php Similar to hook_form_alter, this function lets other modules alter content which is being rendered through the "render" system.

Pages