Functions
Search API
Primary tabs
| Name |
Location |
Description |
|---|---|---|
| hook_enable |
includes/ |
This hook will be executed when a module is enabled in the system. It will be executed AFTER hook_install. |
| 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_currently_advising_box |
includes/ |
This will let us re-arrange or add new elements to the Currently Advising box, which appears at the top of the screen once a student has been selected (or for a student when they log in). |
| hook_form_alter |
includes/ |
Alter forms which are created using the Form API |
| hook_menu_handle_replacement_pattern |
includes/ |
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). |
| 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… |
| 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. |
| arg |
includes/ |
Returns the component of the page's path. |
| fp_http_request |
includes/ |
Send a request through the Internet and return the result as an object. |
| timer_start |
includes/ |
Begin a microtime timer for later use. |
| timer_read |
includes/ |
Works with the timer_start() function to return how long it has been since the start. |
| fp_get_random_string |
includes/ |
Returns a random string of length len. |
| fp_clear_cache |
includes/ |
Call all modules which implement hook_clear_cache |
| fp_no_html_xss |
includes/ |
Remove any possiblilty of a malicious attacker trying to inject nonsense. From: https://paragonie.com/blog/2015/06/preventing-xss-vulnerabilities-in-php... |
| filter_markup |
includes/ |
Filter HTML, allowing only certain tags, and removing dangerous attributes. |
| filter_xss |
includes/ |
This function is taken almost directly from Drupal 7's core code. It is used to help us filter out dangerous HTML which the user might type. From the D7 documentation: |
| filter_xss_split |
includes/ |
Like the filter_xss function, this is taken from D7's _filter_xss_split function |
| filter_xss_attributes |
includes/ |
|
| filter_xss_bad_protocol |
includes/ |
|
| fp_strip_dangerous_protocols |
includes/ |
|
| fp_validate_utf8 |
includes/ |
|
| fp_get_machine_readable |
includes/ |
Simple function to convert a string into a machine-readable string. |
| fp_get_degree_classifications |
includes/ |
Return back an assoc array of our set degree classifications, separated by "level" |
| fp_get_degree_classification_details |
includes/ |
Returns back an assoc array for the supplied code. Looks like: $arr["level_num"] = number $arr["title"] = the title |
| get_term_structures |
includes/ |
Return an array version of the term_id_structure field from the admin settings |
| fp_get_requirement_types |
includes/ |
Returns back an array of all the available requirement types (by code) that have been defined. |
| fp_load_degree |
includes/ |
This function provides a pass-thru to $d = new DegreePlan(args). However, it allows for quick caching look-up, so it should be used when possible instead of $x = new DegreePlan. |