Skip to content
Snippets Groups Projects
Commit f392e425 authored by Grzegorz Rola's avatar Grzegorz Rola
Browse files

Merge branch 'feature/readme' into 'master'

feature(readme): readme

See merge request !21
parents 02cc7cd0 71b111ba
No related branches found
No related tags found
1 merge request!21feature(readme): readme
Pipeline #11461 failed with stages
in 3 minutes and 4 seconds
......@@ -18,7 +18,7 @@ It also handles dismiss functionality with AJAX requests.
PHP 5.5 or later.
## Composer
## Installation with composer
You can install the bindings via [Composer](http://getcomposer.org/). Run the following command:
......@@ -32,7 +32,7 @@ To use the bindings, use Composer's [autoload](https://getcomposer.org/doc/01-ba
require_once 'vendor/autoload.php';
```
## Manual instalation
## Manual installation
If you do not wish to use Composer, you can [download the latest release](https://gitlab.com/wpdesk/wp-notice/-/jobs/artifacts/master/download?job=library). Then, to use the Notices, include the init.php file.
......@@ -42,7 +42,7 @@ require_once('/path/to/wp-desk/wp-notice/init.php');
## Getting Started
Simple usage looks like:
### Simple usage looks like
```php
$notice = wpdesk_wp_notice('Notice text goes here');
......@@ -59,6 +59,26 @@ $notice = new \WPDesk\Notice\Notice('Notice text goes here');
Notice must be used before WordPress action `admin_notices`. WordPress admin actions order is listed [here](https://codex.wordpress.org/Plugin_API/Action_Reference#Actions_Run_During_an_Admin_Page_Request).
## Project documentation
## Permanent dismissible notices
PHPDoc: https://wpdesk.gitlab.io/wp-notice/index.html
### AJAX handler
To use permanent dismissible notices AJAX handler must be created and hooks initialized:
```php
wpdesk_init_wp_notice_ajax_handler();
// Is equivalent to:
( new \WPDesk\Notice\AjaxHandler() )->hooks();
```
### Displaying
To display permanent dismissible notice:
```php
wpdesk_permanent_dismissible_wp_notice( 'Notice text goes here', 'notice-name' );
// Is equivalent to
$notice = new \WPDesk\Notice\PermanentDismissibleNotice( 'Notice text goes here', 'notice-name' );
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment