Skip to content
This repository has been archived by the owner on Jul 26, 2024. It is now read-only.

Latest commit

 

History

History
109 lines (68 loc) · 6.66 KB

README.md

File metadata and controls

109 lines (68 loc) · 6.66 KB
Raw

HRSWP Blocks

Support Level Build Status Release Version WordPress tested up to version 6.6.1 code style: prettier GPLv3 License

Overview

Caution

As of 26 July 2024, this project is archived and no longer being actively maintained.

The WSU HRS WordPress plugin provides custom blocks tailored for the WSU Human Resource Services Theme. It also replaces some WP Core blocks, such as the Buttons block, that offer options that are not appropriate under the HRS style guide.

Description

Blocks

This plugin adds several custom blocks. Some provide relatively simple layout blocks and others provide more complex blocks that include front-end JavaScript. It adds the following content blocks:

  • Accordion
  • Callout
  • Filter
  • Notification
  • Posts List
  • Sidebar

The Accordion and Filter blocks both include frontend JavaScript that is loaded when one of those blocks is active on a page.

The plugin replaces the following WP Core blocks:

  • Button
  • Buttons

The plugin also adds several blocks that handle displaying position data from external data sources. These blocks are:

  • Job Classifications
  • Salary Data
  • List Awards

These blocks -- and therefore the plugin -- require the HRSWP Sqlsrv DB plugin to function properly.

Settings

The HRSWP Blocks plugin also includes optional block editor publication status protection. In Settings > HRS Settings, the "Protected IDs" setting allows admins to specify a list of page or post IDs to restrict publication status actions. The "revert to draft" option will be removed from any published page or post in this list for non-admin users.

Installation

This plugin is not in the WordPress plugins directory. You have to install it manually either with SFTP or from the WordPress plugins screen:

  1. Download the latest version from GitHub and rename the .zip file to: hrswp-plugin-blocks.zip.
  2. From here you can either extract the files into your plugins directory via SFTP or navigate to the Plugins screen in the admin area of your site to upload it through the plugin uploader (steps 3-5).
  3. Select Plugins > Add New and then select the "Upload Plugin" button.
  4. Select "Browse" and locate the downloaded .zip file for the plugin (it must be a file in .zip format) on your computer. Select "Install Now."
  5. You should receive a message that the plugin installed correctly. Select "Activate Plugin" or return to the plugins page to activate later.

Dependencies

This plugin requires the HRSWP Sqlsrv DB plugin to ensure the external content blocks function properly. This plugin must be installed separately.

Updates

Please note that this plugin will not update automatically and will not notify of available updates. It is your responsibility to make sure you stay up to date with the latest version. It does include a GitHub repository URL in the Update URI field, so if you have a plugin that can update from GitHub then this plugin should be compatible with that.

Deactivating and Deleting: Plugin Data

This plugin does not store any user information. The only data it saves is an option in the database to track the protected post/page ID option. Deactivating the plugin through the WordPress plugins screen UI will retain the option. Uninstalling through the WP interface will delete the option entirely. Deleting the plugin directly from the server (not through the plugins screen UI) will circumvent this cleanup action and will not delete the plugin data.

For Developers

The HRSWP Blocks plugin development environment relies on NPM, using the @wordpress/scripts package, and Composer. The package.json and composer.json configuration files manage dependencies for testing and building the production version of the theme. The NPM scripts in package.json do most of the heavy lifting. Please follow the development workflow outlined in the Contributing guide.

Initial Setup

  1. Clone the HRSWP Blocks plugin to a directory on your computer.
  2. Change into that directory.
  3. Install the NPM and Composer dependencies.
  4. Ensure linting and coding standards checks are working -- this should exit with zero (0) errors.
  5. Create a new branch for local development.

In a terminal:

git clone https://github.com/washingtonstateuniversity/hrswp-plugin-blocks.git hrswp-plugin-blocks
cd hrswp-plugin-blocks
npm install
composer install
npm run lint
git checkout -b new-branch-name

Build Commands

The following commands will handle basic build functions.

  • npm run build: Transforms the code according the configuration so it’s ready for production and optimized for the best performance.
  • npm run lint: Check all PHP and CSS files for coding standards compliance.
  • npm run start: Transforms your code according the configuration provided so it’s ready for development.

See the scripts section of package.json for additional available commands.

Support Level

Archived: WSU HRS no longer maintains this plugin.

Changelog

All notable changes are documented in the CHANGELOG.md, with dates and version numbers.

Contributing

Please submit bugs and feature requests through GitHub Issues. Refer to CONTRIBUTING.md for the development workflow and details for submitting pull requests.