Project

General

Profile

CiviCRM cheatsheet » History » Revision 2

Revision 1 (Brienne Kordis, 10/12/2022 07:26 PM) → Revision 2/11 (Brienne Kordis, 10/12/2022 07:27 PM)

# CiviCRM cheatsheet 

 ### Custom Entities & Extensions 
    * A new Entity (think: Contact, Event) can be added to CiviCRM via an extension 
        * use the `civix` [commands](https://docs.civicrm.org/dev/en/latest/extensions/civix/) to create the extension. 
    * To create core fields on the new extension, edit the XML file of the extension. Reference this [guide](https://docs.civicrm.org/dev/en/latest/framework/database/schema-definition/) for the options. 
     * To add custom fields on the new extension, follow this [guide](https://docs.civicrm.org/dev/en/latest/step-by-step/create-entity/#121-making-our-entity-available-for-custom-data). It is also helpful to read about [managed entities](https://docs.civicrm.org/dev/en/latest/api/v4/managed/) before tackling custom fields. 
    * You can include configured Search Kit searches and Form Builder forms in your extension. 
        * _Search Kit_ #### Search Kit 
          * Create, configure, and save your search and any desired displays 
          * Go to **Support > Developer > API Explorer v4** 
          * Set the Entity to *Saved Search* and the Action to *export* (You will need the id of the saved search, so if unknown, do a *get* first) 
          * Fill in the id of the saved search and click **Execute** 
          * On the upper right corner of the results box, change *View as JSON* to *View as PHP* 
          * Copy the results 
          * Paste the results in a new file named `SavedSearch_name-of-saved-search.mgd.php` within the *managed* folder within the particular extension's folder. Note that you might need to create the *managed* folder as `civix` does not generate it automatically, but if you created custom fields as noted above, then you will have already added it. Also make sure that you add `<?php` to the top of the file! 
        * _Form Builder_ #### Form Builder 
          * Create, configure, and save your forms 
          * In the root folder of your extension, create an *ang* folder if it does not yet exist 
          * Move the files (both the html and json) related to your form(s) from their default location into the ang folder of your extension 
              * The default location, such as for WordPress sites is `/wp-content/uploads/civicrm/ang`