Skip to content
Snippets Groups Projects

Compare revisions

Changes are shown as if the source revision was being merged into the target revision. Learn more about comparing revisions.

Source

Select target project
No results found

Target

Select target project
  • documentation/docs/dev
  • totten/dev
  • bgm/dev
  • ivan_compucorp/dev
  • seamuslee/dev
  • artfulrobot/dev
  • ufundo/dev
  • wmortada/dev
  • lucky091588/dev
  • DaveD/dev
  • jtwyman/dev
  • rukkykofi/dev
  • JonGold/dev
  • jaapjansma/developer-docs
  • alainb/dev
  • noah/dev
  • justinfreeman/dev
  • pradeep/dev
  • larssg/dev
  • eileen/dev
  • darrick/dev
  • mattwire/dev
  • colemanw/dev
  • homotechsual/dev
  • JoeMurray/dev
  • maynardsmith/dev
  • kurund/dev
  • rocxa/dev
  • AllenShaw/dev
  • bradleyt/dev
  • chrisgaraffa/dev
  • martin.w/dev
  • herbdool/dev
  • MattTrim1/dev
  • Detlev/dev
  • ErikHommel/dev
  • brienne/devdocs
  • pminf/dev
  • SarahFG/dev
  • ayduns/dev
  • JKingsnorth/dev
  • ginkgomzd/dev
  • nicol/dev
  • almeidam/dev
  • arthurm/dev
  • damilare/dev
  • semseysandor/dev
  • major/devdocs
  • usha.makoa/dev
  • yurg/dev
  • shaneonabike/dev
  • andie/dev
  • mmyriam/dev
  • gngn/dev
  • florian-dieckmann/dev
  • jade/dev
  • luke.stewart/dev
  • vinaygawade/dev
58 results
Show changes
site_name: Developer Guide
repo_url: https://github.com/civicrm/civicrm-dev-docs
site_url: https://docs.civicrm.org/dev/en/latest/
repo_url: https://lab.civicrm.org/documentation/docs/dev
edit_uri: https://lab.civicrm.org/documentation/docs/dev/-/edit/master/docs/
site_description: A guide for CiviCRM developers.
site_author: The CiviCRM community
theme: material
theme:
name: material
icon:
repo: fontawesome/brands/gitlab
pages:
markdown_extensions:
- attr_list
- admonition
- def_list
- toc:
permalink: true
- pymdownx.details
- pymdownx.highlight:
guess_lang: true
extend_pygments_lang:
- name: php
lang: php
options:
startinline: true
- pymdownx.superfences:
css_class: codehilite
- pymdownx.inlinehilite:
css_class: codehilite
- pymdownx.tilde
- pymdownx.betterem
- pymdownx.mark
plugins:
- search:
lang: en
nav:
- Home: index.md
- Basics:
- Developer Community: basics/community.md
- Requirements: basics/requirements.md
- Useful Skills: basics/skills.md
- Planning Your Project: basics/planning.md
- Buildkit:
- Overview: tools/buildkit.md
- Apt-Get: tools/buildkit/apt-get.md
- Docker: tools/buildkit/docker.md
- Generic: tools/buildkit/generic.md
- Nix: tools/buildkit/nix.md
- Vagrant: tools/buildkit/vagrant.md
- Virtual Desktop: tools/buildkit/virtual.md
- Tools:
- Development Tools: tools/index.md
- Buildkit: tools/buildkit.md
- civibuild: tools/civibuild.md
- cividist: tools/cividist.md
- civilint: tools/civilint.md
......@@ -30,48 +68,80 @@ pages:
- Reviewing a PR: core/pr-review.md
- Verifying a Bug Fix: core/verify-fix.md
- Release Process: core/release-process.md
- Dependencies: core/dependencies.md
- Form Builder (Afform):
- Overview: afform/overview.md
- Afform Core: afform/afform-core.md
- Form Builder: afform/form-builder.md
- Search Forms: afform/search-forms.md
- Events: afform/afform-events.md
- Behaviors: afform/afform-behaviors.md
- Search Kit:
- Overview: searchkit/overview.md
- Query Building with APIv4: searchkit/queries.md
- Links and Tasks: searchkit/tasks.md
- Displays and the AngularJS UI: searchkit/displays.md
- Add Saved Search to Your Own Extension: searchkit/extension.md
- Financial:
- Overview: financial/overview.md
- Order API: financial/orderAPI.md
- Payment API: financial/paymentAPI.md
- Entities: financial/financialentities.md
- Recurring Contributions: financial/recurring-contributions.md
- Extensions:
- Basics: extensions/index.md
- Packaging Options: extensions/packaging.md
- civix: extensions/civix.md
- civix (legacy): extensions/civix-legacy.md
- Extension Structure: extensions/structure.md
- info.xml File: extensions/info-xml.md
- Managed Entities: extensions/managed.md
- Documentation: extensions/documentation.md
- Pop-up Help: extensions/helptext.md
- Translation: extensions/translation.md
- Publishing Extensions: extensions/publish.md
- Extension Lifecycle: extensions/lifecycle.md
- Troubleshooting: extensions/troubleshooting.md
- Advanced Patterns: extensions/advanced.md
- Payment Processors:
- Payment Processors: extensions/payment-processors/index.md
- Payment Processor Types: extensions/payment-processors/types.md
- Creating a Payment Processor: extensions/payment-processors/create.md
- Overview: extensions/payment-processors/overview.md
- The Payment Class: extensions/payment-processors/paymentclass.md
- Testing: extensions/payment-processors/testing.md
- CMS-specific development: extensions/cms-specific.md
- API:
- API Intro: api/index.md
- API Interfaces: api/interfaces.md
- APIv4:
- APIv4 Usage: api/v4/usage.md
- APIv4 Actions: api/v4/actions.md
- APIv4 Joins: api/v4/joins.md
- APIv4 Chaining: api/v4/chaining.md
- APIv4 Custom Data: api/v4/custom-data.md
- APIv4 Fields: api/v4/fields.md
- Relational Data:
- Implicit Joins: api/v4/implicit-joins.md
- Explicit Joins: api/v4/explicit-joins.md
- Set Operations: api/v4/set-ops.md
- Option Lists: api/v4/pseudoconstants.md
- Chaining: api/v4/chaining.md
- Custom Data: api/v4/custom-data.md
- Managed APIv4 Entities: api/v4/managed.md
- Differences Between Api v3 and v4: api/v4/differences-with-v3.md
- APIv4 Changes: api/v4/changes.md
- APIv4 Architecture: api/v4/architecture.md
- APIv4 Changelog: api/v4/changes.md
- APIv4 REST: api/v4/rest.md
- APIv3:
- APIv3 Usage: api/v3/usage.md
- APIv3 Interfaces: api/v3/interfaces.md
- APIv3 Actions: api/v3/actions.md
- APIv3 Options: api/v3/options.md
- APIv3 Joins: api/v3/joins.md
- APIv3 Chaining: api/v3/chaining.md
- APIv3 Custom Data: api/v3/custom-data.md
- APIv3 Examples: api/v3/examples.md
- APIv3 Changes: api/v3/changes.md
- APIv3 Changelog: api/v3/changes.md
- APIv3 REST: api/v3/rest.md
- WordPress REST Interface: api/v3/wp-rest.md
- API ERDs: api/ERDs/index.md
- Hooks:
- Hooks Introduction: hooks/index.md
- Hooks Changelog: hooks/changes.md
- Usage:
- Hooks in Extensions: hooks/usage/extension.md
- Hooks in Symfony: hooks/usage/symfony.md
......@@ -84,6 +154,7 @@ pages:
- hook_civicrm_batchQuery: hooks/hook_civicrm_batchQuery.md
- Case Hooks:
- hook_civicrm_caseChange: hooks/hook_civicrm_caseChange.md
- hook_civicrm_caseEmailSubjectPatterns: hooks/hook_civicrm_caseEmailSubjectPatterns.md
- hook_civicrm_caseTypes: hooks/hook_civicrm_caseTypes.md
- hook_civicrm_post_case_merge: hooks/hook_civicrm_post_case_merge.md
- hook_civicrm_pre_case_merge: hooks/hook_civicrm_pre_case_merge.md
......@@ -91,9 +162,11 @@ pages:
- hook_civicrm_alterLocationMergeData: hooks/hook_civicrm_alterLocationMergeData.md
- hook_civicrm_copy: hooks/hook_civicrm_copy.md
- hook_civicrm_custom: hooks/hook_civicrm_custom.md
- hook_civicrm_customPre: hooks/hook_civicrm_customPre.md
- hook_civicrm_managed: hooks/hook_civicrm_managed.md
- hook_civicrm_merge: hooks/hook_civicrm_merge.md
- hook_civicrm_post: hooks/hook_civicrm_post.md
- hook_civicrm_postCommit: hooks/hook_civicrm_postCommit.md
- hook_civicrm_postSave_table_name: hooks/hook_civicrm_postSave_table_name.md
- hook_civicrm_pre: hooks/hook_civicrm_pre.md
- hook_civicrm_referenceCounts: hooks/hook_civicrm_referenceCounts.md
......@@ -122,8 +195,11 @@ pages:
- hook_civicrm_validateForm: hooks/hook_civicrm_validateForm.md
- GUI Hooks:
- hook_civicrm_activeTheme: hooks/hook_civicrm_activeTheme.md
- hook_civicrm_alterBundle: hooks/hook_civicrm_alterBundle.md
- hook_civicrm_alterCustomFieldDisplayValue: hooks/hook_civicrm_alterCustomFieldDisplayValue.md
- hook_civicrm_alterEntityRefParams: hooks/hook_civicrm_alterEntityRefParams.md
- hook_civicrm_alterMenu: hooks/hook_civicrm_alterMenu.md
- hook_civicrm_alterAdminPanel: hooks/hook_civicrm_alterAdminPanel.md
- hook_civicrm_buildAmount: hooks/hook_civicrm_buildAmount.md
- hook_civicrm_caseSummary: hooks/hook_civicrm_caseSummary.md
- hook_civicrm_contact_get_displayname: hooks/hook_civicrm_contact_get_displayname.md
......@@ -137,20 +213,26 @@ pages:
- hook_civicrm_pageRun: hooks/hook_civicrm_pageRun.md
- hook_civicrm_searchColumns: hooks/hook_civicrm_searchColumns.md
- hook_civicrm_searchTasks: hooks/hook_civicrm_searchTasks.md
- hook_civicrm_searchKitTasks: hooks/hook_civicrm_searchKitTasks.md
- hook_civicrm_summary: hooks/hook_civicrm_summary.md
- hook_civicrm_summaryActions: hooks/hook_civicrm_summaryActions.md
- hook_civicrm_themes: hooks/hook_civicrm_themes.md
- <del>hook_civicrm_tabs</del>: hooks/hook_civicrm_tabs.md
- hook_civicrm_tabset: hooks/hook_civicrm_tabset.md
- hook_civicrm_xmlMenu: hooks/hook_civicrm_xmlMenu.md
- Import Hooks:
- hook_civicrm_importAlterMappedRow: hooks/hook_civicrm_importAlterMappedRow.md
- <del>hook_civicrm_import</del>: hooks/hook_civicrm_import.md
- Mail Hooks:
- hook_civicrm_alterMailContent: hooks/hook_civicrm_alterMailContent.md
- hook_civicrm_alterMailer: hooks/hook_civicrm_alterMailer.md
- hook_civicrm_alterMailParams: hooks/hook_civicrm_alterMailParams.md
- hook_civicrm_alterMailStore: hooks/hook_civicrm_alterMailStore.md
- hook_civicrm_alterMailingRecipients: hooks/hook_civicrm_alterMailingRecipients.md
- hook_civicrm_emailProcessor: hooks/hook_civicrm_emailProcessor.md
- hook_civicrm_emailProcessorContact: hooks/hook_civicrm_emailProcessorContact.md
- hook_civicrm_mailingGroups: hooks/hook_civicrm_mailingGroups.md
- hook_civicrm_mailSetupActions: hooks/hook_civicrm_mailSetupActions.md
- hook_civicrm_postEmailSend: hooks/hook_civicrm_postEmailSend.md
- hook_civicrm_postMailing: hooks/hook_civicrm_postMailing.md
- hook_civicrm_unsubscribeGroups: hooks/hook_civicrm_unsubscribeGroups.md
......@@ -160,10 +242,13 @@ pages:
- Permission Hooks:
- hook_civicrm_aclGroup: hooks/hook_civicrm_aclGroup.md
- hook_civicrm_aclWhereClause: hooks/hook_civicrm_aclWhereClause.md
- hook_civicrm_alterApiRoutePermissions: hooks/hook_civicrm_alterApiRoutePermissions.md
- hook_civicrm_alterAPIPermissions: hooks/hook_civicrm_alterAPIPermissions.md
- hook_civicrm_notePrivacy: hooks/hook_civicrm_notePrivacy.md
- hook_civicrm_invalidateChecksum: hooks/hook_civicrm_invalidateChecksum.md
- <del>hook_civicrm_notePrivacy</del>: hooks/hook_civicrm_notePrivacy.md
- hook_civicrm_permission: hooks/hook_civicrm_permission.md
- hook_civicrm_permission_check: hooks/hook_civicrm_permission_check.md
- hook_civicrm_permissionList: hooks/hook_civicrm_permissionList.md
- hook_civicrm_selectWhereClause: hooks/hook_civicrm_selectWhereClause.md
- Profile Hooks:
- hook_civicrm_buildProfile: hooks/hook_civicrm_buildProfile.md
......@@ -172,6 +257,11 @@ pages:
- hook_civicrm_searchProfile: hooks/hook_civicrm_searchProfile.md
- hook_civicrm_validateProfile: hooks/hook_civicrm_validateProfile.md
- hook_civicrm_viewProfile: hooks/hook_civicrm_viewProfile.md
- Queue Hooks:
- hook_civicrm_queueActive: hooks/hook_civicrm_queueActive.md
- hook_civicrm_queueRun: hooks/hook_civicrm_queueRun.md
- hook_civicrm_queueStatus: hooks/hook_civicrm_queueStatus.md
- hook_civicrm_queueTaskError: hooks/hook_civicrm_queueTaskError.md
- Report Hooks:
- hook_civicrm_alterReportVar: hooks/hook_civicrm_alterReportVar.md
- SMS Hooks:
......@@ -180,14 +270,22 @@ pages:
- hook_civicrm_cron: hooks/hook_civicrm_cron.md
- hook_civicrm_preJob: hooks/hook_civicrm_preJob.md
- hook_civicrm_postJob: hooks/hook_civicrm_postJob.md
- Token Hooks/listeners:
- civi.token.eval: hooks/civi.token.eval.md
- civi.token.list: hooks/civi.token.list.md
- <del>hook_civicrm_tokens</del>: hooks/hook_civicrm_tokens.md
- <del>hook_civicrm_tokenValues</del>: hooks/hook_civicrm_tokenValues.md
- Uncategorized Hooks:
- hook_civicrm_alterBadge: hooks/hook_civicrm_alterBadge.md
- hook_civicrm_alterBarcode: hooks/hook_civicrm_alterBarcode.md
- hook_civicrm_alterExternUrl: hooks/hook_civicrm_alterExternUrl.md
- hook_civicrm_alterLogTables: hooks/hook_civicrm_alterLogTables.md
- hook_civicrm_alterMailingLabelParams: hooks/hook_civicrm_alterMailingLabelParams.md
- hook_civicrm_alterPaymentProcessorParams: hooks/hook_civicrm_alterPaymentProcessorParams.md
- hook_civicrm_alterRedirect: hooks/hook_civicrm_alterRedirect.md
- hook_civicrm_alterSettingsFolders: hooks/hook_civicrm_alterSettingsFolders.md
- hook_civicrm_alterSettingsMetaData: hooks/hook_civicrm_alterSettingsMetaData.md
- hook_civicrm_alterUFFIelds: hooks/hook_civicrm_alterUFFields.md
- hook_civicrm_angularModules: hooks/hook_civicrm_angularModules.md
- hook_civicrm_apiWrappers: hooks/hook_civicrm_apiWrappers.md
- hook_civicrm_buildAsset: hooks/hook_civicrm_buildAsset.md
......@@ -197,20 +295,24 @@ pages:
- <del>hook_civicrm_contactListQuery</del>: hooks/hook_civicrm_contactListQuery.md
- hook_civicrm_container: hooks/hook_civicrm_container.md
- hook_civicrm_coreResourceList: hooks/hook_civicrm_coreResourceList.md
- hook_civicrm_crudLink: hooks/hook_civicrm_crudLink.md
- <del>hook_civicrm_crudLink></del>: hooks/hook_civicrm_crudLink.md
- hook_civicrm_crypto: hooks/hook_civicrm_crypto.md
- hook_civicrm_cryptoRotateKey: hooks/hook_civicrm_cryptoRotateKey.md
- hook_civicrm_eventDiscount: hooks/hook_civicrm_eventDiscount.md
- hook_civicrm_export: hooks/hook_civicrm_export.md
- hook_civicrm_fileSearches: hooks/hook_civicrm_fileSearches.md
- hook_civicrm_geocoderFormat: hooks/hook_civicrm_geocoderFormat.md
- hook_civicrm_getAssetUrl: hooks/hook_civicrm_getAssetUrl.md
- hook_civicrm_import: hooks/hook_civicrm_import.md
- hook_civicrm_oauthProviders: hooks/hook_civicrm_oauthProviders.md
- hook_civicrm_oauthReturn: hooks/hook_civicrm_oauthReturn.md
- hook_civicrm_oauthReturnError: hooks/hook_civicrm_oauthReturnError.md
- <del>hook_civicrm_optionValues</del>: hooks/hook_civicrm_optionValues.md
- hook_civicrm_postIPNProcess: hooks/hook_civicrm_postIPNProcess.md
- hook_civicrm_queryObjects: hooks/hook_civicrm_queryObjects.md
- hook_civicrm_recent: hooks/hook_civicrm_recent.md
- hook_civicrm_tokens: hooks/hook_civicrm_tokens.md
- hook_civicrm_tokenValues: hooks/hook_civicrm_tokenValues.md
- hook_civicrm_scanClasses: hooks/hook_civicrm_scanClasses.md
- hook_civicrm_unhandledException: hooks/hook_civicrm_unhandledException.md
- hook_civicrm_userContentPolicy: hooks/hook_civicrm_userContentPolicy.md
- Testing:
- Testing: testing/index.md
- Continuous Integration: testing/continuous-integration.md
......@@ -218,10 +320,13 @@ pages:
- PHPUnit Tests: testing/phpunit.md
# - Codeception Tests: testing/codeception.md
- Selenium Tests: testing/selenium.md
- Mink Tests: testing/mink.md
- Javascript:
- Karma Tests: testing/karma.md
# - Protractor Tests: testing/protractor.md
- QUnit Tests: testing/qunit.md
- Codeception: testing/codeception.md
- Protractor: testing/protractor.md
- Other:
- Upgrade Tests: testing/upgrades.md
- Manual Tests: testing/manual.md
......@@ -232,6 +337,7 @@ pages:
- Permissions: security/permissions.md
- Access Control: security/access.md
- Reporting Vulnerabilities: security/reporting.md
- Request Forgery: security/csrf.md
- Framework:
- AJAX Pages and Forms Reference: framework/ajax.md
- AngularJS:
......@@ -240,21 +346,33 @@ pages:
- AngularJS File Names: framework/angular/files.md
- AngularJS Loader: framework/angular/loader.md
- AngularJS Changesets: framework/angular/changeset.md
- API Architecture: framework/api-architecture.md
- Asset Builder: framework/asset-builder.md
- Authentication: framework/authx.md
- Autocompletes: framework/autocomplete.md
- Bootstrap Process: framework/bootstrap.md
- Backbone Reference: framework/backbone.md
- Bundle Reference: framework/bundle.md
- Cache Reference: framework/cache.md
- CiviMail: framework/civimail.md
- CiviReport: framework/civireport.md
- Codebase: framework/codebase.md
- Database:
- Overview: framework/database/index.md
- XML Schema definition: framework/database/schema-definition.md
- Schema Design: framework/database/schema-design.md
- Transaction Reference: framework/database/transactions.md
- Cryptography Reference: framework/crypto.md
- Entities:
- CiviCRM Entities: framework/entities/index.md
- Schema Design: framework/entities/schema-design.md
- Migrating from Legacy XML: framework/entities/schema-definition.md
- Database Transaction Reference: framework/transactions.md
- Formatting: framework/formatting.md
- File System: framework/filesystem.md
- PseudoConstant Reference: framework/pseudoconstant.md
- Import: framework/import.md
- Logging Reference: framework/logging.md
- Mixins:
- Introduction: framework/mixin/index.md
- New Mixin: framework/mixin/create.md
- Standard Mixins: framework/mixin/standard.md
- OAuth Reference: framework/oauth.md
- Pipe Reference: framework/pipe.md
- Pseudoconstant (Option List) Reference: framework/pseudoconstant.md
- QuickForm Reference:
- QuickForm: framework/quickform/index.md
- Entity Reference Field: framework/quickform/entityref.md
......@@ -262,7 +380,19 @@ pages:
- Region Reference: framework/region.md
- Routing: framework/routing.md
- Resources Reference: framework/resources.md
- Setting Reference: framework/setting.md
- Service Container: framework/services.md
- Setting:
- Introduction: framework/setting/index.md
- Usage: framework/setting/usage.md
- Settings Properties: framework/setting/properties.md
- Extension Settings: framework/setting/extension.md
- Core Settings: framework/setting/core.md
- Setup Reference:
- Overview: framework/setup/index.md
- Getting Started: framework/setup/getting-started.md
- New Installer: framework/setup/new-installer.md
- New Plugin: framework/setup/new-plugin.md
- Manage Plugins: framework/setup/plugins.md
- Template Reference:
- Templates: framework/templates/index.md
- Customizing Templates: framework/templates/customizing.md
......@@ -271,40 +401,27 @@ pages:
- Token Reference: framework/token.md
- UI Reference: framework/ui.md
- Upgrade Reference: framework/upgrade.md
- Workflow Message Reference: framework/message.md
- Translation:
- Translation: translation/index.md
- Extensions Translation: translation/extensions.md
- Extensions Translation: extensions/translation.md
- Database localized fields and upgrades: translation/database.md
- Standards:
- Coding Standards: standards/index.md
- PHP Standards: standards/php.md
- Javascript Standards: standards/javascript.md
- Database Standards: standards/database.md
- Entity Standards: standards/entity.md
- Review Standards: standards/review.md
- Review Template (DEL): standards/review/template-del-1.0.md
- Review Template (MC): standards/review/template-mc-1.0.md
- Review Template (WORD): standards/review/template-word-1.0.md
- Documentation:
- Writing Documentation: documentation/index.md
- Documenting Extensions: documentation/extensions.md
- Documenting Extensions: extensions/documentation.md
- Markdown: documentation/markdown.md
- Style Guide: documentation/style-guide.md
markdown_extensions:
- attr_list
- admonition
- def_list
- toc:
permalink: true
- pymdownx.highlight:
guess_lang: true
extend_pygments_lang:
- name: php
lang: php
options:
startinline: true
- pymdownx.superfences:
css_class: codehilite
- pymdownx.inlinehilite:
css_class: codehilite
- pymdownx.tilde
- pymdownx.betterem
- pymdownx.mark
- Step by Step Guides:
- Create entity: step-by-step/create-entity.md
- Create a custom Case token: step-by-step/create-custom-case-token.md
- Create Cached Configuration Container: step-by-step/create-cached-config-container.md
......@@ -7,7 +7,7 @@ api/general api
hooks/hook_civicrm_trigger_info hooks/hook_civicrm_triggerInfo
testing/setup testing
testing/javascript testing/karma
framework/schema-definition framework/database/schema-definition
framework/schema-definition framework/entities/schema-definition
api/params api/v3/options
api/usage api/v3/usage
api/actions api/v3/actions
......@@ -22,3 +22,6 @@ core/develop tools/git
basics/filesystem framework/filesystem
core/architecture framework/codebase
framework/civimail/tokens https://docs.civicrm.org/user/en/latest/common-workflows/tokens-and-mail-merge/
framework/api-architecture api/v4/architecture
documentation/extensions extensions/documentation
translation/extensions extensions/translation
\ No newline at end of file
......@@ -173,7 +173,7 @@ Smart+group+testing testing/manual/#smart-group
Tarball+installation+testing testing/manual/#tarball
Contributing+to+CiviCRM+using+GitHub tools/git/#github
Git+Commit+Messages+for+CiviCRM tools/git/#committing
Transaction+Reference framework/database/transactions
Transaction+Reference framework/entities/transactions
Backbone+Reference framework/backbone
Extensions+and+Permissions security/permissions#extensions
Customize+Built-in+Profile+Contribution+and+Event+Registration+Screens framework/templates/customizing
......