/external-files-in-media-library

Repository for WordPress-Plugin External Files in Media Library

Primary LanguagePHP

External files in media library

About

This repository provides the features of the WordPress plugin External files in media library. 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.

Hint

As user of the plugin you find documentation for protocols and handling in the doc-directory.

Usage

After checkout go through the following steps:

Using ant

  1. copy build/build.properties.dist to build/build.properties.
  2. modify the build/build.properties file - note the comments in the file.
  3. after that the plugin can be activated in WordPress.

Using Taskfile

  1. Run this command: task prepare
  2. after that the plugin can be activated in WordPress.

Release

from local environment with ant

  1. increase the version number in build/build.properties.
  2. execute the following command in build/: ant build
  3. after that you will find a zip file in the release directory which could be used in WordPress to install it.

from local environment with Taskfile

  1. execute the following command in main directory: task release -- 5.0.0 - adjust the version number.
  2. after that you will find a zip file in the release directory which could be used in WordPress to install it.

on GitHub

  1. Create a new tag with the new version number.
  2. The release zip will be created by GitHub action.

Translations

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

generate pot-file

Run in main directory:

wp i18n make-pot . languages/external-files-in-media-library.pot --exclude=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/

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=eml_ --exclude=Section.php --exclude=Tab.php --exclude=Import.php --exclude=Export.php --exclude=Field_Base.php --exclude=Settings.php --exclude=Page.php --exclude=Rest.php

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=*/attributes/*,*/blocks/*,*/example/*,*/css/*,*/vendor/*,*/node_modules/*,*/svn/* --standard=WordPress-VIP-Go .

Analyse with PHPStan

vendor/bin/phpstan analyse

Check with plugin "Plugin Check"

wp plugin check --error-severity=7 --warning-severity=6 --include-low-severity-errors --categories=plugin_repo --format=json --slug=external-files-in-media-library .