Skip to content

Official Wordpress plugin for your ProvenExpert account.

Notifications You must be signed in to change notification settings

provenexpert/wordpress-plugin

Repository files navigation

ProvenExpert

About

This repository provides the features of the WordPress plugin ProvenExpert. The repository is used as a basis for deploying the plugin to the WordPress repository. It is not intended to run as a plugin as it is, even if that is possible for development.

Preparations

Add this in your wp-config.php for development:

define( 'WP_ENVIRONMENT_TYPE', 'local' );
define( 'WP_DEVELOPMENT_MODE', 'plugin' );

You need to install:

  • composer
  • npm
  • wp-cli

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

Translations of this plugin are managed by https://translate.wordpress.org. It is not necessary to generate our own language files, although this is possible and sometimes helpful to detect possible errors.

We recommend to use PoEdit to translate texts for this plugin.

generate pot-file

Run in main directory:

wp i18n make-pot . languages/provenexpert.pot --exclude=blocks/awards/src/,blocks/bar/src/,blocks/circle/src/,blocks/landing/src/,blocks/seal/src/,blocks/proseal/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

generate optimized PHP-file

wp i18n make-php languages

Check for WordPress Coding Standards

Initialize

composer install

Run

vendor/bin/phpcs --standard=ruleset.xml .

Repair

vendor/bin/phpcbf --standard=ruleset.xml .

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/*,*/build/*,*/node_modules/*,*/blocks/*,*/svn/*,*/languages/* --standard=WordPress-VIP-Go .

Generate documentation

vendor/bin/wp-documentor parse app --format=markdown --output=doc/hooks.md --prefix=provenexpert

About

Official Wordpress plugin for your ProvenExpert account.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages