https://github.com/threadi/play-audio-once
Provides an option for Gutenbergs Audio-Block to prevent multiple playbacks.
https://github.com/threadi/play-audio-once
wordpress-gutenberg wordpress-plugin
Last synced: 5 months ago
JSON representation
Provides an option for Gutenbergs Audio-Block to prevent multiple playbacks.
- Host: GitHub
- URL: https://github.com/threadi/play-audio-once
- Owner: threadi
- Created: 2022-03-01T23:41:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-10-20T19:24:01.000Z (8 months ago)
- Last Synced: 2025-10-20T21:25:39.017Z (8 months ago)
- Topics: wordpress-gutenberg, wordpress-plugin
- Language: PHP
- Homepage: https://wordpress.org/plugins/play-audio-once/
- Size: 3.56 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
Awesome Lists containing this project
README
# Play audio once
This repository is the database for the plugin _Play audio once_. This plugin makes it possible to set audio files in the Gutenberg editor so that a visitor can only play them once.
## Usage
After checkout go through the following steps:
1. copy _build/build.properties.dist_ to _build/build.properties_.
2. modify the build/build.properties file - note the comments in the file.
3. execute the command in _build/_: `ant init`
4. after that the plugin can be activated in WordPress
## Release
1. increase the version number in _build/build.properties_.
2. execute the following command in _build/_: `ant build`
3. after that you will finde in the release directory a zip file which could be used in WordPress to install it.
## Translations
I recommend to use [PoEdit](https://poedit.net/) to translate texts for this plugin.
### generate pot-file
Run in main directory:
`wp i18n make-pot . languages/play-audio-once.pot --exclude=src,svn`
### update translation-file
1. Open .po-file of the language in PoEdit.
2. Go to "Translate" > "Update from POT-file".
3. After this the new entries are added to the language-file.
### export translation-file
1. Open .po-file of the language in PoEdit.
2. Go to File > Save.
3. Upload the generated .mo-file and the .po-file to the plugin-folder languages/
### generate json-translation-files
Run in main directory:
`wp i18n make-json languages`
OR use ant in build/-directory: `ant json-translations`
## Build blocks
### Requirements
`npm install`
### Run for development
`npm start`
### Run for release
`npm run build`
Hint: will be called by ant-command mentioned above.
## Check for WordPress Coding Standards
### Initialize
`composer install`
### Run
`vendor/bin/phpcs --standard=ruleset.xml .`
### Repair
`vendor/bin/phpcbf --standard=ruleset.xml .`
## Generate documentation
`vendor/bin/wp-documentor parse app --format=markdown --output=docs/hooks.md --prefix=play_audio_once_`
## Check for WordPress VIP Coding Standards
Hint: this check runs against the VIP-GO-platform which is not our target for this plugin. Many warnings can be ignored.
### Run
`vendor/bin/phpcs --extensions=php --ignore=*/vendor/*,*/attributes/*,*/node_modules/*,*/svn/*,*/releases/*,*/app/Dependencies/* --standard=WordPress-VIP-Go .`
## Analyse with PHPStan
`vendor/bin/phpstan analyse`