can_read_field
Filter user permission to see the output of a custom field.
You need to have a working knowledge of Hooks before you get started.
Parameters
Name | Type | Description |
---|---|---|
$permission |
parameter |
(boolean) |
$params |
parameter |
(array) associative array with contextual data |
Boilerplate Code
Use the boilerplate code to start using the filter, and add your own logic to modify the first argument and return it.
Clickfwd\Hook\Filter::add('can_read_field', function($permission, $params)
{
// Uncomment line below to view available data passed into hook
// fwd_dd($permission, $params);
return $permission;
});
Examples
Hide a Specific Custom Field
The `jr_city` custom field will not be shown to anyone.
Clickfwd\Hook\Filter::add('can_read_field', function($permission, $params)
{
$fieldName = 'jr_city';
if ( $params['field']['name'] == $fieldName )
{
return false;
}
return $permission;
}, 10);
Hide a Specific Custom Field for Guests
The `jr_city` custom field will only be shown to logged in users.
Clickfwd\Hook\Filter::add('can_read_field', function($permission, $params)
{
$fieldName = 'jr_city';
$auth = S2Object::make('auth');
if ( $auth->guest && $params['field']['name'] == $fieldName )
{
return false;
}
return $permission;
}, 10);
Source Files
/services/authorization/field_permissions.php