document member fieldtype extension hooks

Author: intoeetive

docs/add-ons/pro-variables/type.md

@@ -60,7 +60,7 @@ Allows applying modifiers, which, among other, are used to apply [on-the-fly ima
 
 ## Grid
 
-Uses the native [Grid field](/fieldtypes/grid.md). All native types are available, _except for Relationships_. To output the variable, use the `{exp:pro_variables:pair}` or `{exp:pro_variables:single}` tag where appropriate. You can use any of Grid’s [parameters](/fieldtypes/grid.md#parameters) and [variables](/fieldtypes/grid.ms#variables) using these tags. Additionally, one more parameter is available:
+Uses the native [Grid field](/fieldtypes/grid.md). All native types are available, _except for Relationships and Members_. To output the variable, use the `{exp:pro_variables:pair}` or `{exp:pro_variables:single}` tag where appropriate. You can use any of Grid’s [parameters](/fieldtypes/grid.md#parameters) and [variables](/fieldtypes/grid.ms#variables) using these tags. Additionally, one more parameter is available:
 
 ### Parameters
 

docs/development/extension-hooks/extension-hooks-overview.md

@@ -29,6 +29,7 @@ Core hooks are categorized into 5 categories:
     - [Output Library](development/extension-hooks/global/output.md)
     - [Pagination Library](development/extension-hooks/global/pagination.md)
     - [Relationships Fieldtype](development/extension-hooks/global/relationships.md)
+    - [Members Fieldtype](development/extension-hooks/global/member-ft.md)
     - [Session Library](development/extension-hooks/global/session.md)
     - [Template Library](development/extension-hooks/global/template.md)
     - [Text Helper](development/extension-hooks/global/text-helper.md)

docs/development/extension-hooks/global/member-ft.md

@@ -0,0 +1,60 @@
+---
+lang: php
+---
+
+<!--
+    This source file is part of the open source project
+    ExpressionEngine User Guide (https://github.com/ExpressionEngine/ExpressionEngine-User-Guide)
+
+    @link      https://expressionengine.com/
+    @copyright Copyright (c) 2003-2020, Packet Tide, LLC (https://packettide.com)
+    @license   https://expressionengine.com/license Licensed under Apache License, Version 2.0
+-->
+
+# Members Fieldtype Extension Hooks
+
+[TOC=3]
+
+### `member_relationships_display_field($entry_id, $field_id, $sql)`
+
+| Parameter  | Type     | Description                                             |
+| ---------- | -------- | ------------------------------------------------------- |
+| \$entry_id | `Int`    | Entry ID of entry being edited.                         |
+| \$field_id | `Int`    | Field ID of field currently being loaded.               |
+| \$sql      | `String` | Compiled SQL about to be run to gather related members. |
+| Returns    | `Array`  | Result Array of query result.                           |
+
+Allows developers to modify the existing query that retrieves related members for the publish field or to perform their own queries to return related members.
+
+How it's called:
+
+    if (ee()->extensions->active_hook('member_relationships_display_field') === TRUE)
+    {
+        $related = ee()->extensions->call(
+            'member_relationships_display_field',
+            $entry_id,
+            $this->field_id,
+            ee()->db->_compile_select()
+        );
+    }
+    else
+    {
+        $related = ee()->db->get()->result_array();
+    }
+
+NOTE: **Note:** To use this hook, you can either add to the existing Active Record call, or call `ee()->db->_reset_select()` to cancel the Active Record call and start your own, or modify the passed compiled SQL.
+
+### `member_relationships_post_save($ships, $entry_id, $field_id)`
+
+| Parameter  | Type    | Description                                    |
+| ---------- | ------- | ---------------------------------------------- |
+| \$ships    | `Array` | Array of member IDs to be related to the entry. |
+| \$entry_id | `Int`   | Entry ID of entry being saved.                 |
+| \$field_id | `Int`   | Field ID of field currently being saved.       |
+| Returns    | `Array` | Array of relationships.                        |
+
+Allows developers to modify or add to the relationships array before saving.
+
+How it's called:
+
+    $ships = ee()->extensions->call('member_relationships_post_save', $ships, $entry_id, $field_id);

docs/fieldtypes/member.md

@@ -13,9 +13,7 @@ Members Fieldtype allows selecting one or multiple members and associating those
 
 [TOC]
 
-Relationships are an extremely powerful tool that allow you to connect Entries in one Channel to those in another one, or even to other entries in the same channel. This ability allows you to store very complex content in your Channel entries.
-
-This fieldtype is currently only limited to Channels.
+Members fieldtype is the tool that allow you to connect Members to Channel Entries. This ability allows you to store very complex content in your Channel entries. For example, you could create a Channel called "Articles" and then create a Channel Field called "Authors" that is a Members fieldtype. You could then associate one or more Members with each Article entry. This would allow you to display the author's name, bio, photo, etc. on the Article page.
 
 ![members field](_images/field_members.png)
 

docs/fieldtypes/relationships.md

@@ -11,7 +11,7 @@
 
 [TOC]
 
-Relationships are an extremely powerful tool that allow you to connect Entries in one Channel to those in another one, or even to other entries in the same channel. This ability allows you to store very complex content in your Channel entries.
+Relationships are an extremely powerful tool that allows you to connect Entries in one Channel to those in another one, or even to other entries in the same channel. This ability allows you to store very complex content in your Channel entries.
 
 This fieldtype is currently only limited to Channels.
 

docs/toc_sections/_advanced_usage_toc.yml

@@ -203,6 +203,8 @@
               href: development/extension-hooks/global/pagination.md
             - name: Relationships Fieldtype
               href: development/extension-hooks/global/relationships.md
+            - name: Members Fieldtype
+              href: development/extension-hooks/global/member-ft.md
             - name: Session Library
               href: development/extension-hooks/global/session.md
             - name: Template Library