https://github.com/rumur/wp-notice
[WordPress] The small OOP wrapper allows to work with WordPress notices.
https://github.com/rumur/wp-notice
notices wordpress
Last synced: 5 months ago
JSON representation
[WordPress] The small OOP wrapper allows to work with WordPress notices.
- Host: GitHub
- URL: https://github.com/rumur/wp-notice
- Owner: rumur
- License: mit
- Created: 2020-06-16T16:38:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-04T21:47:47.000Z (almost 5 years ago)
- Last Synced: 2026-01-14T15:06:03.095Z (5 months ago)
- Topics: notices, wordpress
- Language: PHP
- Homepage:
- Size: 59.6 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# wp-notice
The small OOP wrapper that allows working with WordPress notices nice and clean.
### Minimum Requirements:
- PHP: 7.2+
- WordPress: 5.3+
## Installation
```composer require rumur/wp-notice```
### Themosis 2.x
```php console vendor:publish --provider='Rumur\WordPress\Notice\NoticeServiceProvider'```
### Sage 10.x
```wp acorn vendor:publish --provider='Rumur\WordPress\Notice\NoticeServiceProvider'```
### Register into WordPress
It registers the renderer functionality, that will display all notifications added by the package.
```php
registerIntoWordPress();
/**
* The notice function that just need to return a string.
*
* @return string
*/
function rmr_notice_as_function() {
return __('Hello From Function', 'text-domain');
}
```
```php
isPayed()) {
// Simple way.
Notice::info(__('Congrats', 'text-domain'));
// Makes a success message from the Noticeable instance
Notice::success(new ExampleNotification)
// ⚠️ OPTIONAL ⚠️
// Will be always displaying the notice,
// unless `DISABLE_NAG_NOTICES` defined and it's set as `true`
// @link https://codex.wordpress.org/Plugin_API/Action_Reference/admin_notices#Disable_Nag_Notices
->nag()
// ⚠️ OPTIONAL ⚠️
// Makes a notice be dismissible. Adds a close button to the notice.
->dismissible()
// ⚠️ OPTIONAL ⚠️
// Makes a notice display it in an alternative way,
// by adding a background color that corresponds to its type.
->asAlternative()
// ⚠️ OPTIONAL ⚠️
// This options tells to a notice to postpone itself and show only when time.
->showLater('tomorrow')
// ⚠️ OPTIONAL ⚠️
// This options tells to a notice to always show up until time.
->showUntil('next friday')
// ⚠️ OPTIONAL ⚠️
// Tells to a notice to show up only on this pages.
->showWhenPage('themes', 'tools' /*,...*/ )
// ⚠️ OPTIONAL ⚠️
// Tells to a notice to show up only if the logged in user has specific role.
->showWhenRole('subscriber', 'author' /*,...*/ )
// ⚠️ OPTIONAL ⚠️
// Tells to a notice to show up only if the logged in user has specific id.
->showWhenUser(1, get_user_by('id', 25) /*,...*/)
// ⚠️ OPTIONAL ⚠️
// Tells to a notice to show up only if the current screen is for specific taxonomies.
->showWhenTaxonomy('category', 'post_tag' /*,...*/ )
// ⚠️ OPTIONAL ⚠️
// Tells to a notice to show up only if the current screen is for specific post type.
->showWhenPostType('post', 'page' /*,...*/ );
}
```
### [Available methods](#available-methods)
| Recurrence | Description |
|------------------------------- |------------------------------------------------------------------------ |
| `->nag();` | Makes nag notice |
| `->dismissible();` | Makes be closable/dismissible |
| `->showWhenRole(...string);` | Tells to show when the current user role is mentioned |
| `->showWhenRoleNot(...string);` | Tells to show when the current user role is not in a mentioned list |
| `->showWhenPage(...string);` | Tells to show when the current screen page is mentioned |
| `->showWhenPageNot(...string);` | Tells to show when the current screen page is not in a mentioned list |
| `->showWhenTaxonomy(...string);` | Tells to show when the current screen is for specific taxonomies |
| `->showWhenTaxonomyNot(...string);` | Tells to show when the current screen is not for taxonomies mentioned in a list |
| `->showWhenPostType(...string);` | Tells to show when the current screen is for specific post types |
| `->showWhenPostTypeNot(...string);` | Tells to show when the current screen is not for post types mentioned in a list |
| `->showWhenUser(...int/WP_User);` | Tells to show when the current user is mentioned |
| `->showWhenUserNot(...int/WP_User);` | Tells to show when the current user is not in a mentioned list |
| `->showLater(...string/int(timestamp)/DateTimeInterface);` | Tells to show the notice later when it's time |
| `->showUntil(...string/int(timestamp)/DateTimeInterface);` | Tells to show the notice until it's time |
>Note, that all conditions are using `OR` operator to check, but if there is a time condition than it'll switch to `AND` instead.
## To delete all traces when uninstalling plugin/theme which is used the package.
In order to delete all traces just call the `flush` method, like this `Notice::flush()`.
## License
This package is licensed under the MIT License - see the [LICENSE.md](https://github.com/rumur/wp-notice/blob/master/LICENSE) file for details.