Skip to content

Commit 71d482c

Browse files
committed
Fix Fluid Field hooks info
coloses ExpressionEngine/ExpressionEngine#1643
1 parent b8b7005 commit 71d482c

File tree

2 files changed

+13
-16
lines changed

2 files changed

+13
-16
lines changed

docs/development/extension-hooks/model/fluid-field.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,39 +19,36 @@ lang: php
1919

2020
| Parameter | Type | Description |
2121
| ---------------- | ------------ | ----------------------------------------------------------------------- |
22-
| \$data | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField |
23-
| \$fluid_field_id | `Array` | The MemberField model object data as an array |
24-
| Returns | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField |
22+
| \$data | `FieldData` | Instance of ExpressionEngine\Model\Content\FieldData for fluid field |
23+
| \$fluid_field_id | `Int` | The ID of Fluid field being fetched |
24+
| Returns | `FieldData` | Current instance of ExpressionEngine\Model\Content\FieldData |
2525

2626
Called before the fluid field field object is returned.
2727

2828
How it's called:
2929

3030
ee()->extensions->call('fluid_field_get_all_data', $data, $fluid_field_id);
3131

32-
TIP: **New in version 6.1.0.**
33-
34-
### `fluid_field_add_field($field_table_name, $values)`
32+
### `fluid_field_add_field($field_table_name, $values, $fluid_field)`
3533

3634
| Parameter | Type | Description |
3735
| ------------------ | ------------ | ----------------------------- |
3836
| \$field_table_name | `String` | Name of Fluid field table |
3937
| \$values | `Array` | The current field values |
38+
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
4039
| Returns | `Array` | Adjusted field values |
4140

4241
Called before the fluid field is inserted. Changes made to the object will be saved automatically.
4342

4443
How it's called:
4544

46-
ee()->extensions->call('fluid_field_add_field', $field_table_name, $values);
47-
48-
TIP: **New in version 6.1.0.**
45+
ee()->extensions->call('fluid_field_add_field', $field_table_name, $values, $fluid_field);
4946

5047
### `fluid_field_update_field($fluid_field, $field_table_name, $values)`
5148

5249
| Parameter | Type | Description |
5350
| ------------------ | ------------ | ----------------------------------------------------------------------- |
54-
| \$fluid_field | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField |
51+
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
5552
| \$field_table_name | `String` | Name of table being changed |
5653
| \$values | `Array` | The current field values |
5754
| Returns | `Array` | Adjusted field values |
@@ -62,19 +59,15 @@ How it's called:
6259

6360
ee()->extensions->call('fluid_field_add_field', $field_table_name, $values);
6461

65-
TIP: **New in version 6.1.0.**
66-
6762
### `fluid_field_remove_field($fluid_field)`
6863

6964
| Parameter | Type | Description |
7065
| ------------------ | ------------ | ----------------------------------------------------------------------- |
71-
| \$fluid_field | `FluidField` | Current instance of ExpressionEngine\Addons\FluidField\Model\FluidField |
66+
| \$fluid_field | `FluidField` | Current instance of [FluidField model](development/models/fluid-field.md) |
7267
| Returns | `null` | |
7368

7469
Called before the fluid field is deleted. Field will be deleted after hook is called
7570

7671
How it's called:
7772

7873
ee()->extensions->call('fluid_field_remove_field', $fluid_field);
79-
80-
TIP: **New in version 6.1.0.**

docs/development/models/fluid-field.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,25 @@ lang: php
1515

1616
**class `ExpressionEngine\Addons\FluidField\Model\FluidField`**
1717

18+
This model is used to manipulate custom field which is being used inside a Fluid Field for certain Channel Entry.
19+
1820
[TOC]
1921

2022
## Properties
2123

2224
- `id` Key
2325
- `fluid_field_id`
2426
- `entry_id`
27+
- `field_group_id`
2528
- `field_id`
2629
- `field_data_id`
2730
- `order`
2831

2932
## Relationships
3033

3134
- `ChannelEntry`
32-
- `ChannelFields`
35+
- `ChannelField`
36+
- `ChannelFieldGroup`
3337
- `FieldField`
3438

3539
## Methods

0 commit comments

Comments
 (0)