Updated Home (markdown)

Igor V Belousov 2015-08-21 22:50:05 +03:00
родитель 1fd8df29aa
Коммит b6b59faff1

43
Home.md

@ -19,3 +19,46 @@ Install
2. Unpack this archive to the `/wp-content/plugins/` directory
3. Activate the plugin through the 'Plugins' menu in WordPress
4. Use batch operations in your code
Use
---
The plugin provides two functions for the programmer.
### batch_operations_notice
Function for output informational messages in admin-page the next time viewing
for the current user.
```php
batch_operations_notice( string $message [, string $type = 'info' ] )
```
* `$message` - Informational message
* `$type` - Type of message. This parameter is responsible for the design of
the message.
There are four types of messages:
* `info` - Message with a blue border on the left
* `success` - Message with a green border on the left
* `warning` - Message with a yellow border on the left
* `error` - Message with a red border on the left
A screenshot of the results of functions:
```php
batch_operations_notice( 'default' );
batch_operations_notice( 'info', 'info' );
batch_operations_notice( 'success', 'success' );
batch_operations_notice( 'warning', 'warning' );
batch_operations_notice( 'error', 'error' );
```
![](https://raw.githubusercontent.com/IgorVBelousov/batch_operations/dev/assets/screenshot-1.png)
### batch_operations_start
Function for starting run batch operations.
```php
batch_operations_start( array $batch_arr [, string $redirect = NULL ] )
```