Plugin Directory

Changeset 1791039


Ignore:
Timestamp:
12/22/2017 04:14:54 AM (8 years ago)
Author:
Todi.Adiatmo
Message:

update readme

File:
1 edited

Legend:

Unmodified
Added
Removed
  • async-background-worker/trunk/readme.txt

    r1791038 r1791039  
    99License URI: https://www.gnu.org/licenses/gpl-3.0.html
    1010
    11 Async Background Worker, more information please visit this page [WordPress](https://tonjoo.github.io/async-background-worker/ "Your favorite software")
     11Async Background Worker, more information please visit this page [https://tonjoo.github.io/async-background-worker/](https://tonjoo.github.io/async-background-worker/ "Documentation")
    1212
    1313== Sample Usage ==
     
    2525
    26261. Add new job to new worker queue using `add_async_job` command
    27     ```php
     27    `
    2828    $job = new stdClass(); 
    2929    // the function to run 
     
    3333   
    3434    add_async_job($job);
    35     ```
     35    `
    36362. Implement function
    37     ```php
     37    `
    3838    function function_to_execute_on_background($data) {
    3939        //do something usefull
    4040        echo "Background job executed successfully\n";
    4141    }
    42     ```
     42    `
    43433. Run `wp background-worker listen`
    4444
    4545== Command ==
    4646
    47 = `wp background-worker` =
    48 
     47`wp background-worker`
    4948Run Async Background Worker once.
    5049
    51 = `wp background-worker listen` =
     50`wp background-worker listen`
    5251Run Async Background Worker in loop (contiously), this is what you want for background worker. WordPress framework is restart in each loop.
    5352
    54 = `wp background-worker listen-daemon` =
     53`wp background-worker listen-daemon`
    5554Run Async Background Worker in loop (contiously) without restart the WordPress framework. **NOTE** if you use this mode, any code change will not be reflected. You must restart the Async Background Worker each time you change code. This save memory and speed up thing.
    5655
    5756== Changelog ==
    58 
    5957= 1.0.0 =
    6058* Initial Release
Note: See TracChangeset for help on using the changeset viewer.