can_read_field

Filter Hook Field Permissions

Filter user permission to see the output of a custom field.

Parameters

$permission

(boolean)

$params

(array) associative array with contextual data

You need to have a working knowledge of Hooks before you get started.

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
  // For JReviews 3.x and earlier use dd instead of fwd_dd
  // fwd_dd($permission, $params);
  
  return $permission;
});
Development & Support
Customizations are not included with support. We provide this information to make it easier for developers to extend the functionality. From time to time we may have some availability for custom work. Get in touch to see if there's an opportunity to work together.

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

  • /services/authorization/field_permissions.php