From b6b59faff15f5473ec29f68c7f6e3a52c1306612 Mon Sep 17 00:00:00 2001 From: Igor V Belousov Date: Fri, 21 Aug 2015 22:50:05 +0300 Subject: [PATCH] Updated Home (markdown) --- Home.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/Home.md b/Home.md index 4944202..bcf322f 100644 --- a/Home.md +++ b/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 ] ) +``` \ No newline at end of file