Skip to content
Docs

Hooks and Filters

These are the extension points the Pro plugin declares. They are generated from the source, so this list matches the code. Hooks that other guides once listed but that do not exist in the code (for example wcap_pro_before_audio_player, wcap_pro_audio_play_start, wcap_pro_player_position, wcap_pro_allowed_file_types) are not part of this plugin.

Player and settings filters

Section titled “Player and settings filters”
  • wcap_pro_player_config (filter): the configuration array handed to the front-end player. Filter it to change playback behaviour for all players.
  • wcap_pro_setting_{key} (filter): a per-setting filter fired for every resolved setting, where {key} is the setting name (for example wcap_pro_setting_default_preview_duration). Receives the resolved value and the key.

Vendor actions

Section titled “Vendor actions”
  • wcap_pro_vendor_before_audio_fields (action): before the vendor audio fields.
  • wcap_pro_vendor_after_audio_fields (action): after the vendor audio fields.
  • wcap_pro_vendor_before_save_audio (action): before vendor audio is saved.
  • wcap_pro_vendor_after_save_audio (action): after vendor audio is saved.

Vendor filters

Section titled “Vendor filters”
  • wcap_pro_vendor_upload_limit (filter): the per-product vendor upload limit.
  • wcap_pro_vendor_player_theme (filter): the theme used for a vendor product.
  • wcap_pro_vendor_audio_data_display (filter): vendor audio data before it is displayed.
  • wcap_pro_vendor_audio_data_save (filter): vendor audio data before it is saved.
  • wcap_pro_vendor_save_names (filter): vendor audio names before save.
  • wcap_pro_vendor_save_urls (filter): vendor audio URLs before save.

Licensing filter

Section titled “Licensing filter”
  • edd_wcap_pro_sl_api_request_verify_ssl (filter): whether the EDD Software Licensing request verifies SSL.

Free-plugin seams Pro relies on

Section titled “Free-plugin seams Pro relies on”

Pro integrates with the free plugin by answering the free plugin’s own filters. These are declared by the free plugin, not by Pro, but they are where Pro plugs in:

  • wcap_public_instance: Pro returns its player subclass so the free plugin renders through it.
  • wcap_preview_hook: Pro returns the configured product-page position.
  • wcap_soundcloud_embed_url: Pro adds its SoundCloud widget parameters.
  • wcap_should_load_assets: Pro also loads assets on shop and category archives when the badge is on.
  • wcap_metabox_max_rows, wcap_metabox_before_rows, wcap_metabox_row_fields, wcap_metabox_row_headings, wcap_metabox_after_rows, wcap_metabox_save: the meta box seams Pro contributes its fields and save step through.

Regenerating this list

Section titled “Regenerating this list”

The canonical list is generated by bin/generate-hook-docs.php into docs/HOOKS.md. To document a hook, add a docblock above its apply_filters() or do_action() call and rerun the generator rather than editing the reference by hand.