Is Feature Enabled
This topic describes the Is Feature Enabled method, which determines whether a feature is enabled for a given user.
Determines whether a feature is enabled for a given user. The purpose of this method is to allow you to separate the process of developing and deploying features from the decision to turn on a feature. Build your feature and deploy it to your application behind this flag, then turn the feature on or off for specific users.
Version
SDK v3.0
Description
This method traverses the client's datafile and checks the feature flag for the feature key that you specify.
- Analyzes the user's attributes.
- Hashes the userID.
The method then evaluates the feature rollout for a user. The method checks whether the rollout is enabled, whether the user qualifies for the audience targeting, and then randomly assigns either on or off based on the appropriate traffic allocation. If the feature rollout is on for a qualified user, the method returns true.
Parameters
The table below lists the required and optional parameters in PHP.
| Parameter | Type | Description |
|---|---|---|
| featureFlagKey required | string | The key of the feature to check. The feature key is defined from the Features dashboard. For more information, see Create feature flags. |
| userId required | string | The ID of the user to check. For more information, see How bucketing works. |
| attributes optional | map | A map of custom key-value string pairs specifying attributes for the user that are used for [audience targeting] (doc:target-audiences). Non-string values are only supported in the 3.0 SDK and above. |
Returns
True if the feature is enabled for the user. Otherwise, false.
Examples
This section shows a simple example of how you can use the IsFeatureEnabled method.
// Evaluate a feature flag and a variable
$enabled = $optimizelyClient->isFeatureEnabled('price_filter', $userId);
$min_price = $optimizelyClient->getFeatureVariableInteger('price_filter', 'min_price', $userId);
Source files
The language/platform source files containing the implementation for PHP is Optimizely.php.
Updated over 2 years ago