Php

1. 1

   Install the package

   Required

   Install the PostHog PHP library using Composer:

   Terminal

   bashCopy

   composer require posthog/posthog-php

2. 2

   Configure PostHog

   Required

   Initialize the PostHog client with your project token and host:

   PHP

   phpCopy

   PostHog\PostHog::init(
       '<ph_project_token>',
       ['host' => 'https://us.i.posthog.com']
   );

3. 3

   Send events

   Recommended

   Once installed, you can manually send events to test your integration:

   PHP

   phpCopy

   PostHog::capture([
       'distinctId' => 'test-user',
       'event' => 'test-event',
   ]);

4. 4

   Evaluate boolean feature flags

   Required

   Check if a feature flag is enabled:

   phpCopy

   $isMyFlagEnabledForUser = PostHog::isFeatureEnabled('flag-key', 'distinct_id_of_your_user')
   if ($isMyFlagEnabledForUser) {
       // Do something differently for this user
   }

5. 5

   Evaluate multivariate feature flags

   Optional

   For multivariate flags, check which variant the user has been assigned:

   phpCopy

   $enabledVariant = PostHog::getFeatureFlag('flag-key', 'distinct_id_of_your_user')
   if ($enabledVariant === 'variant-key') { # replace 'variant-key' with the key of your variant
       # Do something differently for this user
   }

6. 6

   Include feature flag information in events

   Required

   If you want to use your feature flag to breakdown or filter events in your insights, you’ll need to include feature flag information in those events. This ensures that the feature flag value is attributed correctly to the event.

   Note: This step is only required for events captured using our server-side SDKs or API.

   Set send_feature_flags (recommended)

   Set send_feature_flags to true in your capture call:

   PHP

   phpCopy

   PostHog::capture
   
   
   
   

7. 7

   Override server properties

   Optional

   Sometimes, you may want to evaluate feature flags using properties that haven’t been ingested yet, or were set incorrectly earlier. You can provide properties to evaluate the flag with:

   phpCopy

   PostHog::getFeatureFlag(
       'flag-key',
       'distinct_id_of_the_user',
       [
           'your_group_type' => 'your_group_id',
           'another_group_type'
   
   
   
   
   
   
   
   
   

8. 8

   Running experiments

   Optional

   Experiments run on top of our feature flags. Once you’ve implemented the flag in your code, you run an experiment by creating a new experiment in the PostHog dashboard.

9. 9

   Next steps

   Recommended

   Now that you’re evaluating flags, continue with the resources below to learn what else Feature Flags enables within the PostHog platform.

   Resource	Description
   Creating a feature flag (opens in a new tab)	How to create a feature flag in PostHog
   Adding feature flag code (opens in a new tab)	How to check flags in your code for all platforms
   Framework-specific guides

Still have questions?

Ask PostHog AI

Was this page useful?

HelpfulCould be better

Include $feature property

Include the $feature/feature_flag_name property in your event properties:

PHP