diff --git a/docs/hooks/hook_civicrm_alterAdminPanel.md b/docs/hooks/hook_civicrm_alterAdminPanel.md new file mode 100644 index 0000000000000000000000000000000000000000..b670a2b4aba58b164dee0fa64b096d7a0ace38ce --- /dev/null +++ b/docs/hooks/hook_civicrm_alterAdminPanel.md @@ -0,0 +1,26 @@ +# hook_civicrm_alterAdminPanel + +## Summary + +This hook is invoked after all the panels and items on Administer CiviCRM screen have been +generated and allows for direct manipulation of these items and panels. + +## Definition + + hook_civicrm_alterAdminPanel(&adminPanel) + +## Parameters + +- array adminPanel - array of panels on Adminster CiviCRM screen + +## Returns + +## Example + + /** + * Alter panels on administer CiviCRM screen + */ + function example_civicrm_alterAdminPanel(&$adminPanel) { + // don't want to show Multi Site Settings to users as a configuration option + unset($adminPanel['System_Settings']['fields']['weight}.Multi Site Settings']); + }