From dc56e08ce97b06997a5fa3d0ffaebd601e385bed Mon Sep 17 00:00:00 2001
From: Sean Madsen <sean@seanmadsen.com>
Date: Tue, 24 Oct 2017 17:22:35 -0400
Subject: [PATCH] Improve markdown and grammar
---
.../hook_civicrm_alterEntityRefParams.md | 25 ++++++++-----------
1 file changed, 10 insertions(+), 15 deletions(-)
diff --git a/docs/hooks/hook_civicrm_alterEntityRefParams.md b/docs/hooks/hook_civicrm_alterEntityRefParams.md
index 6abf261d..1361236b 100644
--- a/docs/hooks/hook_civicrm_alterEntityRefParams.md
+++ b/docs/hooks/hook_civicrm_alterEntityRefParams.md
@@ -2,7 +2,7 @@
## Summary
-Allows you to modify entityRef field params.
+This hook is called when an `entityRef` field is rendered in a form, which allows you to modify the parameters used to fetch options for this kind of field.
## Availability
@@ -14,22 +14,17 @@ This hook is available in CiviCRM 4.7.27+ (maybe depends on the commit).
## Parameters
-- @param array $params - parameters of entityRef field
-
-## Details
-
- This hook is called when entityRef field is rendered in form, which allows you to modify the parameters used to fetch options for this kind of field.
-
+- array `$params` - parameters of entityRef field
## Example
```php
- function myextension_civicrm_alterEntityRefParams(&$params) {
- // use your custom API to fetch tags of your choice
- if ($params['entity'] == 'tag') {
- $params['entity'] = 'my_tags';
- $params['api'] = array('params' => array('parent_id' => 292));
- }
- ...
- }
+function myextension_civicrm_alterEntityRefParams(&$params) {
+ // use your custom API to fetch tags of your choice
+ if ($params['entity'] == 'tag') {
+ $params['entity'] = 'my_tags';
+ $params['api'] = array('params' => array('parent_id' => 292));
+ }
+ // ...
+}
```
--
GitLab