Functions

Primary tabs

Contains filters are case sensitive
Namesort descending Location Description
get_term_description includes/misc.inc Convert a term ID into a description. Ex: 20095 = Spring of 2009.
get_term_structures includes/misc.inc Return an array version of the term_id_structure field from the admin settings
get_timezones includes/misc.inc Returns an array of all timezones PHP recognizes. Inspired by code from: https://stackoverflow.com/questions/1727077/generating-a-drop-down-list-...
get_timezone_offset includes/misc.inc Returns the offset from the origin timezone to the remote timezone, in seconds.
hook_admin_duplicate_year includes/hook.api.php This hook allows other modules to act when we are using the admin operation of duplicating an entire catalog year's worth of data.
hook_advise_build_screen_elements includes/hook.api.php This hook allows other modules to interact with the AdvisingScreen object adter the build_screen_elements method is called.
hook_advise_build_screen_elements modules/advise/advise.module This is a hook which developers may use to add custom blocks (or perform other operations) onto the advising View or What If screen.
hook_alter_student_profile_items modules/user/user.api.php Allows other modules to alter the "profile items".
hook_alter_student_profile_items includes/hook.api.php 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…
hook_alter_term_id_prior_to_description includes/hook.api.php This hook is called right before retrieving the plain English description for a term_id. It allows modules to change the term_id.
hook_alter_user_attribute_display modules/user/user.api.php This function lets us alter the value of a user attribute, before it is displayed to the user.
hook_apply_draft_changes includes/hook.api.php Allows modules to execute code when the admin user has chose to "apply draft changes".
hook_audit_get_additional_overall_calculations modules/audit/audit.api.php This hook allows other modules to add to the "overall" calculations table near the top of the Audit tab.
hook_audit_modify_approval_types modules/audit/audit.api.php This hook allows the module developer to modify the approval types which will be displayed on the audit tab.
hook_clear_cache includes/hook.api.php Allows each module to perform actions when the cache is cleared.
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.
hook_content_load modules/content/content.api.php This hook is called by the function content_load($cid), and allows other modules to act on content which is being loaded.
hook_content_register_content_type modules/content/content.api.php Sample hook other modules implement to register a content type.
hook_content_save modules/content/content.api.php This hook is called just before saving the content to the database, and allows other modules to act on content before it is writen to the database.
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_course_load includes/hook.api.php Allows modules to act after a course object has been loaded.
hook_course_search_get_course_rotation_schedule modules/course_search/course_search.api.php This is called AFTER the regular course rotation schedule array has been built. Notice it is passed by reference. This lets us make alterations to it.
hook_course_search_get_course_rotation_schedule_not_anticipated modules/course_search/course_search.api.php This is called AFTER the regular course_search_get_course_rotation_schedule_not_anticipated. In general, we want to see if anything is going to be offered in the next 5 years.
hook_cron includes/hook.api.php This hook is called every time the system cron is run.
hook_define_calculation_tests modules/student_priority/student_priority.api.php Lets us modify an array of calculation tests, either adding to it, or altering the existing ones. Notice that $arr is passed by reference.
hook_degree_plan_load includes/hook.api.php Allows modules to hook in after a degree plan object is created & loaded.
hook_disable includes/hook.api.php This hook will be executed when a module is disabled in the system.
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_engagements_handle_incoming_sms_init modules/engagements/engagements.api.php Called when an SMS is received by FlightPath and before any logic, queries, etc., are performed.
hook_engagements_handle_incoming_sms_post_save modules/engagements/engagements.api.php Called at the very end of the engagements_handle_incoming_sms function, after the SMS message has been received, and any alerts or other content have been created, and it has been added to the sms_history table.
hook_exit includes/hook.api.php Allows each module to execute code when the FlightPath page is completely finished.
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_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_form_alter includes/hook.api.php Alter forms which are created using the Form API
hook_fp_get_student_majors includes/hook.api.php Returns a full listing of the student's majors.
hook_get_user_image_url includes/hook.api.php 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_group_load includes/hook.api.php Allows modules to act after a group object has been loaded.
hook_init includes/hook.api.php Allows each module to execute code when the module is first loaded.
hook_init_flightpath_degree includes/hook.api.php Allows a module to act on the degree_plan object AFTER being initialized by the FlightPath module.
hook_install includes/hook.api.php This hook will be executed the first time a module is enabled in the system.
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_menu_alter includes/hook.api.php This hook lets us make alterations to menu items before saving them to the database.
hook_menu_handle_replacement_pattern includes/hook.api.php 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_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_prereqs_get_prereq_warnings_for_course modules/prereqs/prereqs.api.php If implemented, this hook has the option to modify or add more warnings after the original prereqs function is run.
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_sidebar_left_links_alter includes/hook.api.php This hook allows a module to modify the links which appear on the left sidebar.
hook_stats_additional_menublocks includes/hook.api.php 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_status includes/hook.api.php Reports status information which each module is aware of, visible on admin/config/status.
hook_student_load includes/hook.api.php Allows modules to hook in after a new student object is created.

Pages