![Accredible Logo](https://s3.amazonaws.com/accredible-cdn/accredible_logo_sm.png)

# Accredible Wordpress Certificates & Open Badges Plugin

## Overview

The Accredible platform enables organizations to create, manage and distribute digital credentials as digital
certificates or open badges.

An example digital certificate and badge can be viewed here: https://www.credential.net/10000005

This plugin enables you to issue dynamic, digital certificates or open badges on your Wordpress instance.

The plugin also allows you to display certificates and badges to your Wordpress users.

A video walkthrough of the plugin can be viewed here: https://youtu.be/s5krPN6GvTY

## Example Output

![Example Digital Certificate](https://s3.amazonaws.com/accredible-cdn/example-digital-certificate.png)

![Example Open Badge](https://s3.amazonaws.com/accredible-cdn/example-digital-badge.png)

## Compatability

Tested on Wordpress 3+.

---

## Installation

1. Visit https://accredible.com to obtain an API key
2. Install the plugin
3. Activate the plugin through the 'Plugins' menu in WordPress
4. Go to the plugin settings and input your API key
5. Add the widget if desired. It will show a list of certificates or badges for a currently signed in user.
6. Add the shortcode below to a page or post if desired. It will show certificates and badges for a currently signed in user.

```
[accredible_credential image="true" limit="10" style="true"] 
```

### Manually creating certificates

1. Go to the 'Certificates & Badges' page in the Wordpress admin menu.
2. On the list of your users, select which students you would like to issue certificates to and then select a group.
3. Click 'Create Credentials'

![Certificates Admin](https://s3.amazonaws.com/accredible-moodle-instructions/wordpress/certificates-admin.png)

## Frequently Asked Questions

#### How do I get an API key?

Visit https://www.accredible.com to obtain a free API key.

#### How can I show certificates or badges to my users?

You can use the widget or shortcode to display badges or certificates that belong to the current Wordpress user.

The shortcode is:
```
[accredible_credential]
```
but it accepts a number of options:
```
[accredible_credential image="true" limit="10" style="true"]
```

#### Can you add support for another Wordpress LMS or theme?

Sure, just post an issue and we'll get to work: https://github.com/accredible/accredible-certificates/issues

---

## Development Information

### Development setup

- ⚠ Be careful not to **UNINSTALL** the plugin in this docker environment since **WordPress completely removes your local plugin directory** on uninstallation including `.git` so you will lose all your work in the directory. (In contrast, activation and deactivation of the plugin do not trigger any dangerous operations.)

#### Prerequisites

- [Docker](https://www.docker.com/)

#### Step 1: Run Docker containers

Build and run docker containers with `docker-compose`.

```
docker compose up -d
```

#### Step 2: Update DB user's previleges

Log into the MySQL container as the root user (password: `wordpress`). 

```
docker exec -it accredible-certificates-db-1 mysql -u root -p
```

Update `wordpress` user's privileges to create a test database at Step 3.

```
mysql> grant ALL PRIVILEGES ON *.* TO 'wordpress';
```

#### Step 3: Set up PHPUnit

Log into the WordPress container and go to the plugin directory.

```
docker exec -it accredible-certificates-wordpress-1 bash
cd $PLUGIN_DIR
```

Run the following setup commands:

```
bash bin/install-wp-tests.sh wordpress_test $WORDPRESS_DB_USER $WORDPRESS_DB_PASSWORD $WORDPRESS_DB_HOST $WORDPRESS_VERSION

composer install
```

### WordPress

After the setup, WordPress should be running on port `8000`  of your Docker Host. Open it in a web browser and complete the WordPress installation.

### Running Coding Standards

The WordPress container comes with PHP_CodeSniffer and WordPress Coding Standards pre-installed. To check your code against WordPress coding standards:

1. First, access the WordPress container:
```bash
docker exec -it accredible-certificates-wordpress-1 bash
```

2. Check available WordPress coding standards:
```bash
/root/.composer/vendor/bin/phpcs -i
```

3. Run the coding standards check on a specific file:
```bash
/root/.composer/vendor/bin/phpcs --standard=WordPress [filename]
```
```bash
/root/.composer/vendor/bin/phpcbf --standard=WordPress [filename]
```

Note: If you get a "command not found" error, try rebuilding the container to ensure all tools are properly installed:
```bash
docker compose down && docker compose up -d --build
```

### Running Tests

The plugin uses PHPUnit for testing. To run the test suite:

1. First, access the WordPress container:
```bash
docker exec -it accredible-certificates-wordpress-1 bash
```

2. Navigate to the plugin directory:
```bash
cd $PLUGIN_DIR
```

3. Run all tests:
```bash
./vendor/bin/phpunit
```

4. Run tests with verbose output:
```bash
./vendor/bin/phpunit --verbose
```

5. Run a specific test file, reference the class:
```bash
./vendor/bin/phpunit --filter Test_Users_List
```

6. Run a specific test case, reference the test method:
```bash
./vendor/bin/phpunit --filter test_get_users_with_search
```

#### Test Setup

The test environment is automatically set up when you run the initialization script mentioned in the Development setup section. The tests use a separate WordPress test database and include:

- WordPress test framework
- PHPUnit 9.x
- WordPress polyfills for PHPUnit
- Test fixtures in `tests/fixtures/`