Skip to content
Docs

General Settings

General Settings

Section titled “General Settings”

Go to WB Plugins > BuddyPress Giphy > General to configure how GIFs work on your site. All settings are stored in a single WordPress option: bpgp_settings.

The page is divided into cards. Which cards appear depends on your chosen provider: settings that apply only to GIPHY or only to Klipy are hidden when the other provider is active.

GIF Provider

Section titled “GIF Provider”

Option key: bpgp_settings[bp_gif_provider] Default: giphy

Value Description
giphy Use GIPHY as the GIF source. Requires a free GIPHY developer API key.
klipy Use Klipy as the GIF source. Requires a free Klipy API key.

Members search and post GIFs from whichever provider you select. After changing the provider, the API key and filtering cards update to show only that provider’s fields. The other provider’s settings are hidden but remain saved.

GIPHY Connection

Section titled “GIPHY Connection”

Visible only when Provider is set to GIPHY.

Option key: bpgp_settings[bp_giphy_api_key] Default: empty

Paste your GIPHY API key here. After you save or leave the field, the page checks the key against GIPHY’s API:

  • Green check: the key is valid and the GIPHY API is responding.
  • Red cross: the key is invalid (403) or rate-limited (429).

The key is still saved when validation fails, so you can correct it without retyping. To get a key, see Choosing a GIF provider.

Klipy Connection

Section titled “Klipy Connection”

Visible only when Provider is set to Klipy.

Option key: bpgp_settings[bp_klipy_api_key] Default: empty

Paste your Klipy API key here. The same live status indicator applies. To get a key, see Choosing a GIF provider.

Picker Behaviour

Section titled “Picker Behaviour”

Option key: bpgp_settings[bp_giphy_number_of_gifs] Default: 20 Range: 5 to 100 (steps of 5) Klipy cap: 50

Controls how many GIFs the picker loads each time it opens (trending view) and each time a member runs a search. Lower numbers load faster; higher numbers give members more to browse. Klipy caps each request at 50, so values above 50 have no effect when using Klipy. Values are clamped to 5 to 100 on save.

GIPHY Filtering and Rendition

Section titled “GIPHY Filtering and Rendition”

Visible only when Provider is set to GIPHY.

Maximum content rating

Section titled “Maximum content rating”

Option key: bpgp_settings[bp_giphy_content_rating] Default: No limit (empty)

Value Label What it allows
y Y Illustrated content only, no photographic content
g G Suitable for everyone
pg PG May be inappropriate for children
pg-13 PG-13 May be inappropriate under the age of 13
r R Not suitable for users under 17
(empty) No limit All content GIPHY serves

GIPHY filters its results to the rating you set. For a general-audience community, G or PG is a sensible default.

GIF rendition

Section titled “GIF rendition”

Option key: bpgp_settings[bp_giphy_gif_size] Default: original

Controls which pre-rendered size GIPHY returns for the selected GIF. Common options:

Value Description
original Full file size and dimensions. Best quality, largest file. Good for desktop.
fixed_width Width fixed to 200px. Good for mobile.
fixed_width_downsampled 200px wide, reduced to 6 frames. Optimized for mobile scrolling.
fixed_height Height fixed to 200px. Good for mobile.
fixed_height_downsampled 200px tall, 6 frames. Smallest animated rendition.
preview Under 50KB. Duration may be truncated. Good for thumbnails.

Additional *_still (static) and *_small (100px) variants are also available. For mixed desktop/mobile communities, fixed_width or fixed_width_downsampled is a good balance.

Klipy Filtering and Rendition

Section titled “Klipy Filtering and Rendition”

Visible only when Provider is set to Klipy.

Content filter

Section titled “Content filter”

Option key: bpgp_settings[bp_klipy_content_filter] Default: high

Value Description
off No content filtering
low Light filtering
medium Moderate filtering
high Strictest filtering, safest for communities

high is the recommended default. An invalid value submitted outside these four options is coerced back to high on save.

GIF rendition

Section titled “GIF rendition”

Option key: bpgp_settings[bp_klipy_gif_size] Default: md

Value Description
hd High definition. Largest file, best on desktop.
md Medium. Balanced size and quality.
sm Small. Faster loading, good for mobile.
xs Extra small. Smallest file, good for mobile keyboards and thumbnails.

An invalid value reverts to md on save.

Where Members Can Post GIFs

Section titled “Where Members Can Post GIFs”

This card appears only when BuddyPress is active.

Each toggle stores yes when on, or an empty string when off. Each is independent.

Toggle Option key Default What it controls
Profile activity profiles_gif_support off GIF button on member activity and the site-wide activity directory
Group activity groups_gif_support off GIF button on group activity streams
Private messages messages_gif_support off GIF button in the private message composer

bbPress Forums

Section titled “bbPress Forums”

This card appears only when the bbPress plugin is active.

Toggle Option key Default What it controls
Forum topics and replies topic_gif_support yes (set on activation when bbPress is active) GIF button in the TinyMCE editor for bbPress topics and replies

Saving settings

Section titled “Saving settings”

Click Save Changes at the bottom of the page. The plugin validates all values before writing them:

  • API keys are tested against the provider’s API. An invalid key shows a settings error but is still saved so you can see and correct what you entered.
  • The GIF count is clamped to 5 to 100.
  • Content rating, content filter, and rendition values are checked against their allowed lists. An unrecognised value is replaced with the field’s default.
  • Area toggles not present in the submission (unchecked checkboxes) are saved as an empty string, meaning off.
Section titled “Related”