Skip to main content
drupalreleases

Use direct release data with your AI assistant.

Learn more

Funding

Security covered Under active development 2 sites

The Funding module allows Drupal users to display crowdfunding information using a new "Funding YAML" field type. This field type can be added to various entities, enabling users to present funding options from supported providers like GitHub Sponsors, Patreon, and Open Collective, or even custom links.

The Funding module enables Drupal users to present their crowdfunding information to site visitors in a number of beautiful and effective ways. It does so by providing a new Field Type ("Funding YAML"), that when rendered, displays theme-controlled markup.

With this new Field Type you can easily place your site's Funding widgets on almost any entity.

Here are some examples for how you might use the Funding Yaml field type:

  • Add the field to a custom Block Type, and place your site's Funding widgets in the footer.
  • Add the field to a User (or Profile), to allow individual users to display their own funding.
  • Add the field to a custom Content Type, because you've decided each node of that type should have its own Funding widgets.

Configuration Guide

Funding Providers

The first goal of the Funding module aims for parity with GitHub's Funding.yml syntax.

The Funding module does this through its concept of a "Funding Provider".

We may add more advanced support in the future. If you have an idea for a service we should support, please let us know in the issue queue!

Out of the box, we support the following Funding Providers:

  • custom - Custom Links
  • github - GitHub Sponsors
  • hirepage - Hirepage
  • issuehunt - IssueHunt
  • ko_fi - Ko-Fi
  • community_bridge - LFX Mentorship (formerly Community Bridge)
  • liberapay - Liberapay
  • open_collective - Open Collective
  • otechie - Otechie - Doesn't exist anymore.
  • patreon - Patreon
  • tidelift - Tidelift

Funding Contributions

Other modules may easily implement their own Funding providers. Here are the ones we know about.

  • Open Collective - Funding provides advanced Open Collective widgets and can be used to build custom widgets using the Open Collective Api.

Funding Provider Technical Summary

The primary concept to know is that a Funding Provider is a Drupal Plugin. Each plugin is responsible for a single top-level namespace (key) in the YAML. Refer to the Custom URL Funding Provider as an example.

By implementing your own FundingProvider plugin, your module can allow any user to display your new type of crowdfunding widget.

Developer Guide

Funding is supported by you!

This module is supported through various groups and initiatives that are passionate about supporting our communities through Funding.

If you value this module and related contributions, please let us know!

Future

At this time our efforts around the Funding module are focused on creating the first stable release. See the roadmap to stable for more information: #3094555: Roadmap to Stable Release 1.0.x

Additional goals:

  • #3356325: Drupal.org use cases Support the Drupal Association in getting the Funding module ready for Drupal.org. The ideal result would give project maintainers the ability to place funding widgets on their project pages.
  • Post-stable: Define the scope of the next phase. Likely new Funding Providers or widgets. We've gather a list of other funding attempts in the wild for inspiration. Let us know if you see more!

Ask your assistant about Funding

Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works

Depends on

Dependencies of the latest stable release

No dependencies recorded for this project.

Required by

Tracked projects that depend on this one

No tracked projects depend on this one yet.

Activity

Tracked releases
2
Tracked since
Apr 2023
Latest release
3 years ago
Releases (12 mo)
0
Maintenance
Dormant

Releases

Version Type Core PHP Release date
1.0.0-alpha1 Pre-release 8–10 May 2, 2023
1.0.x-dev Dev 8–10 Apr 18, 2023