Flexible, simple, safe. With Kultur-API for Wordpress, your association can quickly and easily exchange data between the website and the database, accept registrations and simplify processes. This wordpress plugin is initiated and maintained by Kulturwunsch Wolfenbüttel e. V. and its members.
It only takes a quick installation from wordpress marketplace.
Do you like the plugin and would you like to support the creators in continually developing it? Please donate an amount of your choice to us.
- Kultur-API for Wordpress
- Getting started
- Contribute
- New functions
- Further development and maintenance
- Help and support
To start, simply install the stable plugin from wordpress market place.
This plugin was developed with the aim of adapting Wordpress websites as flexibly as possible to the needs of a cultural association. The goal is to eliminate the need for specialized knowledge or the need to regularly update static pages to provide current information. The plugin currently includes basic functions, but can be expanded at any time.
If you have ideas or suggestions, please write them in the Issues section or create a pull request. Fundamental changes to the structure or functionality must be discussed in the community before they are adopted into the base branch.
What we won't cover:
- Develop your own software for the administration of the association
- Creating your own interfaces to connect to the culture API
What we cover:
- How to get up and running fast
- Extend WordPress features for full culture integration
- How to integrate your existing API into this plugin
- PHP 7.4 or later
- PHP JSON extension enabled.
- PHP CURL extension enabled
- WordPress 6.3 or later
- Integrate external API (WUNSCH.events or custom)
- Manage event categories
- Manage imparting areas
- Manage partners
- Contact Form 7 integration
- Deactivate email sending
- Transfer forms via API (New cultural guests and new organization members)
- Enhanced ressource loading only on necessary pages
Go to your plugin page. Then enter Kultur-API for WP in the search and click on install. Then you have installed the latest version of the plugin.
Tip
We always recommend using the latest version from the WordPress marketplace, as this version is stable and has been checked for malfunctions.
The development of this plugin is supervised and coordinated by Kulturwunsch Wolfenbüttel e. V. However, it is desirable that everyone can contribute to this plugin and contribute their ideas.
Completely new features that expand the scope of the plugin should be discussed before development. To do this, create a new issue and describe your idea. You should also mention whether it is a feature request or an idea that you can implement yourself. After a vote, the new idea can be submitted for review via a pull request. Please observe all standards.
The plugin uses a simple file structure that makes it possible to expand the range of functions between admin and public at any time.
.
├── .github
├── .wordpress
├── admin
│ └── css
│ └── js
│ └── partials
│ └── class-ka4wp-admin.php
│ └── index.php
├── includes
├── languages
├── public
│ ├── css
│ ├── js
│ └── partials
│ └── style.css
├── routes
│ ├── index.js
│ └── users.js
├── tests
├── index.php
├── kultur-api-for-wp.php
└── uninstall.php
This plugin works with prefixes. All custom entries (posts, taxonomy, pages, etc.) as well as all functions within the plugin must contain the prefix ka4wp_. This is the only way to ensure that there are no compatibility problems with other plugins and to show at all times whether it is a function of this plugin or the function is being used from outside.
This plugin is designed for multilingualism. All texts that this plugin displays must be defined using a text domain. After deployment, new language strings can then be translated via the WordPress developer platform. The text domain of this plugin is kultur-api-for-wp.
Important
All original texts must be in english and the text must be assigned to text domain kultur-api-for-wp. A translation into another language (e.g. German) is then carried out via the developer platform.
This plugin currently does not use its own database tables. If possible, all data should be written into existing standard fields. This increases maintainability and compatibility with later WordPress versions. If it is unavoidable to use existing tables and fields, the WordPress database functions must be used. In addition to the general WordPress table prefix, all tables must also have the ka4wp_ prefix. You also need to make sure that the tables are also removed when you uninstall the plugin.
WordPress already offers functions for many possible actions in the core package. These can be viewed and checked here. In order to keep this plugin compatible for the future, these functions should be used wherever possible. The advantage is that the functions are maintained and updated by the WordPress team. If standard functions do not offer the desired scope, you are allowed to create your own functions in the respective scope (Admin or Public).
Custom posttypes are used in this plugin. A custom posttype is a post that is created and managed by the plugin. WordPress uses custom posttypes to differentiate between pages, standard blog entries and posts created by plugins. The following table provides an overview of the custom posttypes used by this plugin:
| Type | Description |
|---|---|
ka4wp_api |
This type stores all information about the created interfaces. In addition to the predefined WUNSCH.events api, individual interfaces can also be created. |
Note
When using created posts (e.g. in drop-down menus), you should always check whether they have the status publish.
This plugin uses the Taxonomy function to store and provide standardized data. A new taxonomy can be created for each type of data and expanded with metadata. The following table shows which types currently exist and which fields have been expanded.
| Slug | Description | Additional meta data |
|---|---|---|
eventcategories |
Saves all event categories and a description of them | api_managed, enabled, timestamp, shortcut, databse_id |
impartingareas |
Saves all imparting areas and a description of it | api_managed, enabled, timestamp, databse_id |
partners |
Saves api-enabled partners with details (adress f.e.) | api_managed, enabled, timestamp, databse_id |
Shortcodes are a good way to display data with a simple piece of code. With options inside the syntax is the view manageble. At the moment only the ka4wp_partners shortcode is available.
The table show you the options how to configure the shortcode:
| Datafield | Default value | Possible values | Description |
|----------------|-------------------------------------------------------------------|-------------------------------------------------------------|
| partnertype | * (All partners) | 'organizer', 'socialpartner', 'otherpartners' | Which type of partner should queried from the database |
| style | grid | 'grid' or 'table' | Which design should used (table oder flexible grid) |
| view_logo | 1 | 1 or 0 | If the partner logo should displayed |
| view_phone | 1 | 1 or 0 | If the partners phone number should displayed |
| view_adress | 1 | 1 or 0 | If the partners postal adress should displayed |
| view_website | 1 | 1 or 0 | If a button to visit the partners website should displayed |
| grid_xs | 2 | Number between 0 and 12 | How much objects should displayed in a xs grid per row |
| grid_sm | 3 | Number between 0 and 12 | How much objects should displayed in a sm grid per row |
| grid_lg | 4 | Number between 0 and 12 | How much objects should displayed in a lg grid per row |
| grid_xl | 4 | Number between 0 and 12 | How much objects should displayed in a xl grid per row |
This plugin uses functions from "Contact Form 7". The following paragraph describes the integration and configuration options.
By setting up the API for eventcategories and imparting areas, data sets can be used in forms. A data set makes it possible to dynamically design selection fields, radio buttons and checkboxes. The following example shows how data sets are used:
[select <fieldname> use_label_element data:<dataset_name>]
The following data sets are currently available:
| Key | Description |
|---|---|
kulturapi_eventcategories |
Contains all items present in the taxonomy eventcategories. |
kulturapi_impartingareas |
Contains all items present in the taxonomy impartingareas. |
You can find more information about how form fields work here. Tips for developing new datasets can be found here and here.
In the settings of a form you can deactivate that an email is sent after it has been sent. This setting is related to selecting an API.
Cron jobs can be generated in this plugin. Cron jobs are executed cyclically, depending on the system settings, and carry out actions. All cron jobs must be implemented in such a way that they are terminated and deleted when the plugin is deactivated or uninstalled. In addition, a check must be carried out when reactivating the plugin in order to reschedule any existing cron jobs.
A description of all API Endpoints will coming soon.
There a currently no guidelines for new releases. This part of the documentation will filled up after the initial release.
If you want to track and check errors during development, a debug log can be helpful. This plugin includes a function for creating debug logs.
wp_get_development_mode(), ['plugin', 'all']
The documentation of this plugin is an important part of the development. Within the plugin, all features are labeled with the version in which they were added and a brief description of what it does. New features must also contain this information. If there are fundamental changes or if new core functions are to be implemented, it is essential to adapt the README.md file.
In this area you will find help and common errors. Before reporting an error, please check whether it has already been reported.
Before reporting your issue, make sure that the issue you are experiencing aren't already answered by searching the closed issues page on GitHub.
To avoid confusion and to help you resolve your issue as quickly as possible, you should provide a detailed explanation of the problem you are experiencing.
- Go to this page to create a new issue.
- Add a title that describes your problems in as few words as possible.
- Fill all provided fields to help us support you.
Remember that a more detailed issue-description and debug-info might suck to write, but it will help others understand and resolve your issue without asking for the information.
Note: Please be as detailed as possible in the description when creating a new issue. This will help others to more easily understand- and solve your issue. Providing the necessary steps to reproduce the error within your description, adding useful debugging info etc. will help others quickly resolve the issue you are reporting.
-
Please try to follow the PSR-2 codestyle guidelines.
-
Please create your pull requests to the development base that matches the version number you want to change.
-
Create detailed descriptions for your commits, as these will be used in the changelog for new releases.
-
When changing existing functionality, please ensure that the unit-tests working.
-
When adding new stuff, please remember to add new unit-tests for the functionality.