Skip to content
A plugin to create a Course custom post type for WSU Human Resource Services.
PHP JavaScript CSS Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
bin
build
includes
src
templates
.editorconfig
.eslintrc.js
.gitattributes
.gitignore
.npmpackagejsonlintrc.json
.stylelintrc.json
.travis.yml
CHANGELOG.md
LICENSE.txt
README.md
composer.json
composer.lock
hrs-courses.php
index.php
package-lock.json
package.json
phpcs.xml.dist
postcss.config.js
webpack.config.js

README.md

WSUWP HRS Courses

Build Status

Overview

This plugin creates a Courses custom post type with supporting custom taxonomies.

Description

The WSUWP HRS Courses plugin -- designed originally for WSU Human Resource Services -- creates a block-based custom post type for creating and managing courses. It uses a customized archive template with integrated search and relies on several custom blocks to save, store, and retrieve Course data. It also uses a block template to manage the default layout of single and archive Course posts.

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: wsuwp-plugin-hrs-courses.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.

Updates

Please note that this plugin will not update automatically and will not notify of new available updates. It is your responsibility to make sure you stay up to date with the latest version.

Deactivating and Deleting: Plugin Data

If you deactivate the plugin it will unregister the Courses post type and custom taxonomies, but will leave the data untouched. You can reactivate any time and be right back where you started.

If you delete (uninstall) the plugin from the WordPress plugins screen it will trash all of the Courses custom post types and delete the custom taxonomies and terms. So make sure you have a database backup if you think you want to restore any of it. WordPress keeps posts in the Trash for 30 days by default, so you can always reinstall within that window to restore the trashed posts; but you can't get the terms back without a database import.

For Developers

The WSUWP HRS Courses plugin development environment relies primarily on NPM and Composer. The package.json and composer.json configuration files manage necessary dependencies for testing and building the production version of the theme. The NPM scripts in package.json do most of the heavy lifting.

Initial Setup

  1. Clone the WSUWP HRS Courses 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/wsuwp-plugin-hrs-courses.git wsuwp-plugin-hrs-courses
cd wsuwp-plugin-hrs-courses
npm install; composer install
npm test -s
git checkout -b new-branch-name

Build Commands

The following commands will handle basic build functions. (Remove the -s flag to show additional debug info.)

  • npm run build -s: Remove old compiled files such as minified CSS, lint PHP and CSS, and then compile new versions.
  • npm test -s: Check all PHP and CSS files for coding standards compliance.
  • npm run clean -s: Remove old compiled files such as minified CSS.
  • npm run build:styles -s: Compile CSS.

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

WSUP HRS Courses Issues

Please submit bugs, fixes, and feature requests through GitHub Issues. Please read (and adhere to) the guidelines for contributions detailed in the issue templates.

Read the CHANGELOG.md to review release and update notes.

You can’t perform that action at this time.