Function __global->cns_get_all_custom_fields_match_member
Definitions
sources/cns_members.php
- Gets all a member's custom fields that match certain parameters.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $member_id | MEMBER | No | No | required parameter | N/A | N/A | The member |
| $public_view | ?BINARY | No | No | Null | N/A | N/A | That are publicly viewable (null: don't care) |
| $owner_view | ?BINARY | No | No | Null | N/A | N/A | That are owner viewable (null: don't care) |
| $owner_set | ?BINARY | No | No | Null | N/A | N/A | That are owner settable (null: don't care) |
| $encrypted | ?BINARY | No | No | Null | N/A | N/A | That are encrypted (null: don't care) |
| $required | ?BINARY | No | No | Null | N/A | N/A | That are required (null: don't care) |
| $show_in_posts | ?BINARY | No | No | Null | N/A | N/A | That are to be shown in posts (null: don't care) |
| $show_in_post_previews | ?BINARY | No | No | Null | N/A | N/A | That are to be shown in post previews (null: don't care) |
| $special_start | ?BINARY | No | No | Null | N/A | N/A | That start 'cms_' (null: don't care) |
| $show_on_join_form | ?boolean | No | No | Null | N/A | N/A | That are to go on the join form (null: don't care) |
Returns
- A mapping of field title to a map of details: 'RAW' as the raw field value, 'RENDERED' as the rendered field value, 'FIELD_ID' to the field ID, 'EDITABILITY' defining if fractional editing can work on this
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Gets all a member's custom fields that match certain parameters.
*
* @param MEMBER $member_id The member
* @param ?BINARY $public_view That are publicly viewable (null: don't care)
* @param ?BINARY $owner_view That are owner viewable (null: don't care)
* @param ?BINARY $owner_set That are owner settable (null: don't care)
* @param ?BINARY $encrypted That are encrypted (null: don't care)
* @param ?BINARY $required That are required (null: don't care)
* @param ?BINARY $show_in_posts That are to be shown in posts (null: don't care)
* @param ?BINARY $show_in_post_previews That are to be shown in post previews (null: don't care)
* @param ?BINARY $special_start That start 'cms_' (null: don't care)
* @param ?boolean $show_on_join_form That are to go on the join form (null: don't care)
* @return array A mapping of field title to a map of details: 'RAW' as the raw field value, 'RENDERED' as the rendered field value, 'FIELD_ID' to the field ID, 'EDITABILITY' defining if fractional editing can work on this
*/
function cns_get_all_custom_fields_match_member(int $member_id, ?int $public_view = null, ?int $owner_view = null, ?int $owner_set = null, ?int $encrypted = null, ?int $required = null, ?int $show_in_posts = null, ?int $show_in_post_previews = null, ?int $special_start = null, ?bool $show_on_join_form = null) : array
* Gets all a member's custom fields that match certain parameters.
*
* @param MEMBER $member_id The member
* @param ?BINARY $public_view That are publicly viewable (null: don't care)
* @param ?BINARY $owner_view That are owner viewable (null: don't care)
* @param ?BINARY $owner_set That are owner settable (null: don't care)
* @param ?BINARY $encrypted That are encrypted (null: don't care)
* @param ?BINARY $required That are required (null: don't care)
* @param ?BINARY $show_in_posts That are to be shown in posts (null: don't care)
* @param ?BINARY $show_in_post_previews That are to be shown in post previews (null: don't care)
* @param ?BINARY $special_start That start 'cms_' (null: don't care)
* @param ?boolean $show_on_join_form That are to go on the join form (null: don't care)
* @return array A mapping of field title to a map of details: 'RAW' as the raw field value, 'RENDERED' as the rendered field value, 'FIELD_ID' to the field ID, 'EDITABILITY' defining if fractional editing can work on this
*/
function cns_get_all_custom_fields_match_member(int $member_id, ?int $public_view = null, ?int $owner_view = null, ?int $owner_set = null, ?int $encrypted = null, ?int $required = null, ?int $show_in_posts = null, ?int $show_in_post_previews = null, ?int $special_start = null, ?bool $show_on_join_form = null) : array
