Skip to content

Commit 4186326

Browse files
authored
Merge pull request #1021 from ExpressionEngine/fr/new-email-addy-hooks
Adding email address hooks docs
2 parents 0a1a23e + 3b662cf commit 4186326

File tree

3 files changed

+80
-1
lines changed

3 files changed

+80
-1
lines changed

docs/development/extension-hooks/cp/login.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ How it's called:
5454

5555
$this->extensions->call('cp_member_logout');
5656
if ($this->extensions->end_script === TRUE) return;
57-
57+
5858
## `cp_member_reset_password()`
5959

6060
| Parameter | Type |
@@ -67,3 +67,22 @@ How it's called:
6767

6868
$this->extensions->call('cp_member_process_reset_password');
6969
if ($this->extensions->end_script === TRUE) return;
70+
71+
## `cp_member_send_reset_token_start($address)`
72+
73+
| Parameter | Type | Description
74+
| --------- | -------- | ---------------------------------------------------------------
75+
| $address | `String` | Email address posted from the control panel reset password form
76+
| Returns | `String` | Email address after extension processes it
77+
78+
Additional processing of email address sent via control panel reset password form.
79+
80+
How it's called:
81+
82+
if (ee()->extensions->active_hook('member_auth_send_reset_token_start')) {
83+
$address = ee()->extensions->call('member_auth_send_reset_token_start', $address);
84+
if (ee()->extensions->end_script === true) {
85+
return;
86+
}
87+
}
88+

docs/development/extension-hooks/global/email.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,50 @@ lang: php
1313

1414
# Email Library Extension Hooks
1515

16+
## `email_from_address($from, $name)`
17+
18+
| Parameter | Type | Description
19+
| --------- | -------- | --------------------------------------
20+
| $from | `String` | Email `from` address
21+
| $name | `String` | Email `name` for `from` address
22+
| Returns | `Array` | Associative array
23+
24+
Overwrite an email `from` address.
25+
26+
How it's called:
27+
28+
if (ee()->extensions->active_hook('email_from_address')) {
29+
$processed_address = ee()->extensions->call('email_from_address', $from, $name);
30+
$from = $processed_address['from'] ?? $from;
31+
$name = $processed_address['name'] ?? $name;
32+
33+
if (ee()->extensions->end_script === true) {
34+
return;
35+
}
36+
}
37+
38+
## `email_to_address($to)`
39+
40+
| Parameter | Type | Description
41+
| --------- | -------- | --------------------------------------
42+
| $to | `String` | Email `from` address
43+
| Returns | `String` | Manipulated Email `to` address
44+
45+
Overwrite an email `to` address.
46+
47+
How it's called:
48+
49+
if (ee()->extensions->active_hook('email_to_address')) {
50+
$to = ee()->extensions->call('email_to_address', $to);
51+
52+
if (ee()->extensions->end_script === true) {
53+
return;
54+
}
55+
}
56+
1657
## `email_send(&$data)`
1758

59+
1860
| Parameter | Type | Description |
1961
| --------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2062
| &\$data | `Array` | Array of data about email to be sent (see above) passed [by reference](https://php.net/manual/en/language.references.pass.php) so data may be altered without needing to return the altered data |

docs/development/extension-hooks/module/member-auth.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,24 @@ How it's called:
6969
$edata = ee()->extensions->call('member_member_logout');
7070
if (ee()->extensions->end_script === TRUE) return;
7171

72+
## `member_auth_send_reset_token_start($address)`
73+
74+
| Parameter | Type | Description
75+
| --------- | -------- | ---------------------------------------------
76+
| $address | `String` | Email address posted from reset password form
77+
| Returns | `String` | Email address after extension processes it
78+
79+
Additional processing of email address sent via reset password form. Happens after basic security checks, but before email address check occurs.
80+
81+
How it's called:
82+
83+
if (ee()->extensions->active_hook('member_auth_send_reset_token_start')) {
84+
$address = ee()->extensions->call('member_auth_send_reset_token_start', $address);
85+
if (ee()->extensions->end_script === true) {
86+
return;
87+
}
88+
}
89+
7290
## `member_process_reset_password()`
7391

7492
| Parameter | Type | Description |

0 commit comments

Comments
 (0)