Functions
Search API
Primary tabs
| Name |
Location |
Description |
|---|---|---|
| hook_init |
includes/ |
Allows each module to execute code when the module is first loaded. |
| hook_install |
includes/ |
This hook will be executed the first time a module is enabled in the system. |
| hook_submit |
includes/ |
Handle submissions from the Form API |
| hook_cron |
includes/ |
This hook is called every time the system cron is run. |
| hook_validate |
includes/ |
Validates form submissions from the Form API |
| hook_fp_get_student_majors |
includes/ |
Returns a full listing of the student's majors. |
| hook_status |
includes/ |
Reports status information which each module is aware of, visible on admin/config/status. |
| hook_theme_pie_charts |
includes/ |
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/ |
Similar to hook_theme_advise_course_row. This lets the user theme the "select X hours..." row for a group. |
| hook_theme_advise_course_row |
includes/ |
This hook allows another module to alter the way a course row is drawn onto the advising screen. |
| hook_theme_advise_degree_header_row |
includes/ |
This hook allows another module to alter the way a "degree header" row is drawn onto the advising screen. |
| hook_advise_build_screen_elements |
includes/ |
This hook allows other modules to interact with the AdvisingScreen object adter the build_screen_elements method is called. |
| hook_flightpath_can_assign_course_to_group |
includes/ |
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/ |
Is the course allowed to be assigned to the specified degree? Returns TRUE or FALSE |
| hook_alter_term_id_prior_to_description |
includes/ |
This hook is called right before retrieving the plain English description for a term_id. It allows modules to change the term_id. |
| hook_courselist_find_match_allow_course |
includes/ |
This hook his called just before returning a Course object from CourseList::find_best_grade_match or find_most_recent_match. |
| hook_content_alter |
includes/ |
Similar to hook_form_alter, this function lets other modules alter content which is being rendered through the "render" system. |
| hook_alter_student_profile_items |
includes/ |
This hook is called before displaying the student profile box (which appears at the top of the screen on the profile page, as well as other tabs. If bool_mini is set to TRUE, then it means we are showing an abbreviated display, like on the Degree… |
| fpl_reports_stats_additional_menublocks |
includes/ |
Used by the stats module, this will ask other modules to return an array of paths suitable for the fp_render_menu_block() function. In other words, the paths should be the **beginning** of the paths of your custom reports or other links which you… |
| hook_form_alter |
includes/ |
Alter forms which are created using the Form API |
| hook_user_menu_links_alter |
includes/ |
This hook allows you to alter the links which appear under the user menu pulldown, in the top-right of the screen. |
| hook_get_user_image_url |
includes/ |
This accepts a CWID (student_id or faculty_id), and returns back a URL to the user's image, or FALSE if it cannot find one. |
| hook_get_alert_count_by_type |
includes/ |
This will allow modules to add to the "count" for alerts, that generally would trigger a notification badge on the bell at the top-right of the screen. |
| hook_stats_additional_menublocks |
includes/ |
Used by the stats module, this will ask other modules to return an array of paths suitable for the fp_render_menu_block() function. In other words, the paths should be the **beginning** of the paths of your custom reports or other links which you… |
| hook_init_flightpath_degree |
includes/ |
Allows a module to act on the degree_plan object AFTER being initialized by the FlightPath module. |
| hook_save_advising_session_from_post |
includes/ |
This hook allows modules to perform extra functions just after an advising session is saved by the system. |
| hook_menu_handle_replacement_pattern |
includes/ |
This hook is called by the menu system. It allows each module the chance to replace string patterns in its menu items (defined in hook_menu). |
| hook_menu_alter |
includes/ |
This hook lets us make alterations to menu items before saving them to the database. |
| hook_translate |
includes/ |
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_advise_footnote |
includes/ |
This function allows the user to theme footnotes before they are drawn onto the screen. |
| hook_menu |
includes/ |
Allows modules to specify valid URLs in FlightPath, and define what function to call when the user visits that URL. |
| hook_apply_draft_changes |
includes/ |
Allows modules to execute code when the admin user has chose to "apply draft changes". |
| hook_course_load |
includes/ |
Allows modules to act after a course object has been loaded. |
| hook_group_load |
includes/ |
Allows modules to act after a group object has been loaded. |
| hook_degree_plan_load |
includes/ |
Allows modules to hook in after a degree plan object is created & loaded. |
| hook_student_load |
includes/ |
Allows modules to hook in after a new student object is created. |
| hook_perm |
includes/ |
This hook defines available permissions for a module. These perms are used with hook_menu() and the function user_has_permission() |
| hook_user_login |
includes/ |
Perform actions when the user logs in successfully. |
| hook_exit |
includes/ |
Allows each module to execute code when the FlightPath page is completely finished. |
| menu_get_menu_router_item_from_db |
includes/ |
Return array from menu_router for this item. * |
| menu_get_item |
includes/ |
Figure out which menu_router path matches the supplied path and return it. |
| menu_get_items_in_tab_family |
includes/ |
|
| menu_get_items_beginning_with |
includes/ |
Return menu_items whose path begins with the menu_root. Ex: "tools" would return tools/fun and tools/here/there |
| menu_execute_page_request |
includes/ |
|
| menu_check_user_access |
includes/ |
Looks at the router item's details (from menu_get_item) and returns TRUE or FALSE if the user can access this item. |
| menu_get_module_path |
includes/ |
|
| menu_rebuild_cache |
includes/ |
Go through all installed modules and rebuild the menu_router table, based on each module's hook_menu function. |
| menu_convert_replacement_pattern |
includes/ |
Look for modules implementing hook_menu_handle_replacement_pattern, and apply to str. |
| fp_goto |
includes/ |
Redirect the user's browser to the specified internal path + query. |
| l |
includes/ |
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… |