https://github.com/pixelgrade/wp-post-notes
WordPress library for adding public and private notes to posts, pages, or any custom post type.
https://github.com/pixelgrade/wp-post-notes
composer-package custom-post-type-ui library php wordpress wordpress-plugin-development
Last synced: about 1 month ago
JSON representation
WordPress library for adding public and private notes to posts, pages, or any custom post type.
- Host: GitHub
- URL: https://github.com/pixelgrade/wp-post-notes
- Owner: pixelgrade
- License: gpl-2.0
- Created: 2021-08-03T12:38:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-20T08:08:42.000Z (over 4 years ago)
- Last Synced: 2025-08-28T09:51:24.176Z (5 months ago)
- Topics: composer-package, custom-post-type-ui, library, php, wordpress, wordpress-plugin-development
- Language: PHP
- Homepage:
- Size: 89.8 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WP Post Notes
WordPress library for adding public and private notes to posts, pages, or any custom post type.
## About
WordPress library for adding public and private notes to posts, pages, or any custom post type.
## Releases
Before creating a new release zip, run the `composer run prepare-for-release` command to keep everything production-oriented.
## Running Tests
To run the PHPUnit tests, in the root directory of the plugin, run something like:
```
./vendor/bin/phpunit --testsuite=Unit --colors=always
```
or
```
composer run tests
```
Bear in mind that there are **simple unit tests** (hence the `--testsuite=Unit` parameter) that are very fast to run, and there are **integration tests** (`--testsuite=Integration`) that need to load the entire WordPress codebase, recreate the db, etc. Choose which ones you want to run depending on what you are after.
You can run either the unit tests or the integration tests with the following commands:
```
composer run tests-unit
```
or
```
composer run tests-integration
```
**Important:** Before you can run the tests, you need to create a `.env` file in `tests/phpunit/` with the necessary data. You can copy the already existing `.env.example` file. Further instructions are in the `.env.example` file.
## Credits
This WordPress library uses much code/logic extracted and modified from [WooCommerce](https://github.com/woocommerce/woocommerce), mainly the order notes logic.