order_action_form.comment

Apps » Shop-Script » Hooks

Adds custom content to comment-adding form for an order in backend.

Shop-Script

Input (passed by reference)

$params array Order action data.
$params['order_id'] int Order ID.
$params['action_id'] string Action ID.

… your plugin code …

Output

$return

Custom content to be added to comment-adding form.

Shop-Script

Plugin code example

PHP

public function orderActionForm($params)
{
    // When processing event 'order_action_form.comment' or 'order_action_form.*',
    // generate a custom field for the comment-adding form.
    return waHtmlControl::getControl(waHtmlControl::INPUT, 'plugins[' . $this->id . '][some]');
}

public function orderAction($params)
{
    // When processing event 'order_action.comment' or 'order_action.*',
    // use the value submitted by a user in the custom field.
    $post = waRequest::post('plugins');
    waLog::dump($post[$this->id]['some'], 'shop/plugins/' . $this->id . '/order-action.log');
}