ESCEP CMS WP

This WordPress Plugin is part of the ESCEP CMS Workflow. It is designed to import the workflow's XML files in the NITF schema.

Installation and configuration

The plugin is not yet listed on https://wordpress.org/plugins/.

To see how to install and configure the plugin, please head over to the repository's Wiki.

Development

It would be best if you had a working WordPress instance to develop this plugin. If you don't have any, I suggest giving LWDE a try.

Technical dependencies

• PHP 7.4
• WordPress 6
• Classic editor for WordPress (Blocks are not yet supported)

Structure of the Plugin

.
├── LICENSE            # License file
├── README.md          # This README.md
├── admin              # Implementation of the admin page
├── composer.json      # Composer configuration
├── composer.lock      # Composer lock file
├── core               # !!! Copy of the core library !!!
├── docs               # Documentation for WordPress Admin
├── ecwp.php           # Plugin file
├── includes           # Utils and helper classes
├── phpcs.xml.dist     # phpcs configuration
├── uninstall.php      # Uninstall procedure
└── vendor             # Composer dependencies

Preparation

Enable WordPress' debug.log

Enabling WordPress' debug.log in wp-content will allow you to receive detailed debug messages. To do so, add these tree statements to your wp-config.php:

define('WP_DEBUG', true);
define('WP_DEBUG_DISPLAY', true);
define('WP_DEBUG_LOG', true);

Update the core ⚠️

For deployment reasons, this repository also holds a copy of the ESCEP CMS Core library. You may have to update the core with a copy of the core's repository. If you make changes in the ESCEP Core application, please push them to the core's repository and open a merge request against develop there. Otherwise, push all your changes, including possible updates from the core repository, with your branch and open a merge request against develop. The core time will ensure that the main branch will contain the correct version of the ESCEP CMS Core library.

Install the dev. dependencies

For development, I suggest installing the development dependencies.

composer install

PHPCS

Please run phpcs and phpcbf in your IDE or editor to follow the WordPress coding standards. You can also run phpcs with composer:

composer run-script phpcs

Troubleshooting

The referenced sniff does not exist

You may face phpcs errors after the first run. For instance:

ERROR: Referenced sniff "WordPress.Arrays.ArrayIndentation" does not exist

Run "phpcs --help" for usage information

To fix them, run this once:

composer run-script phpcs-init-rulesets

Afterwards, rerun composer run-script phpcs to make sure, PHPCS is working.

Deprecation notice for trim()

If you face deprecation warnings for trim() in phpcs' output, follow the given path and change the trim's usage. Please note that this issue is from WPCS' package code base. Each time you reinstall the composer vendors, you have to redo that.

FILE: /path/to/file.php
-----------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------
 1 | ERROR | An error occurred during processing; checking has been aborted.
   |       | The error message was: trim(): Passing null to parameter #1
   |       | ($string) of type string is deprecated in /path/to/vendor/
   |       | wp-coding-standards/wpcs/WordPress/Sniffs/WP/I18nSniff.php
   |       | on line 194 (Internal.Exception)
-----------------------------------------------------------------------------

To remove (wrong) messages like the example above, change the affected code to a valid implementation. For example:

- $cl_supported_version = trim( PHPCSHelper::get_config_data( 'minimum_supported_wp_version' ));
+ $cl_supported_version = trim( PHPCSHelper::get_config_data( 'minimum_supported_wp_version' ) ?? '' );

License

ESCEP CMS WP
Copyright (C) 2022 Andreas (development@meen.ch), and Contributors

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.