ResultFactory — Creating Results

ResultFactory creates different result types for controller responses.

Available result types:

Page — Full page with layout
Json — JSON response
Redirect — HTTP redirect
Raw — Raw content response
Forward — Internal forward to another action

Injecting ResultFactory:

public function __construct(
    Context $context,
    \Magento\Framework\Controller\Result\Factory $resultFactory
) {
    parent::__construct($context);
    $this->resultFactory = $resultFactory;
}

Creating results:

// Page result
$page = $this->resultFactory->create(
    \Magento\Framework\View\Result\Page::class
);

// JSON result
$json = $this->resultFactory->create(
    \Magento\Framework\Controller\Result\Json::class
);

// Redirect result
$redirect = $this->resultFactory->create(
    \Magento\Framework\Controller\Result\Redirect::class
);

// Raw result
$raw = $this->resultFactory->create(
    \Magento\Framework\Controller\Result\Raw::class
);

Page results render full HTML pages with layout.

Basic page result:

public function execute()
{
    $page = $this->resultFactory->create(
        \Magento\Framework\View\Result\Page::class
    );
    
    $page->getConfig()->getTitle()->set(__('My Page Title'));
    
    return $page;
}

Page with layout XML:

public function execute()
{
    $page = $this->resultFactory->create(
        \Magento\Framework\View\Result\Page::class
    );
    
    // Set active theme/layout
    $page->addHandle('vendor_module_my_page');
    
    // Set page title
    $page->getConfig()->getTitle()->set(__('Product Details'));
    
    // Register content block
    $block = $page->getLayout()->getBlock('content');
    $block->setProduct($product);
    
    return $page;
}

Page with custom layout update:

public function execute()
{
    $page = $this->resultFactory->create(
        \Magento\Framework\View\Result\Page::class
    );
    
    $page->getConfig()->addPageAsset('Vendor_Module::css/custom.css');
    $page->getConfig()->addPageAsset('Vendor_Module::js/custom.js');
    
    $page->getConfig()->getTitle()->set(__('Custom Page'));
    
    return $page;
}

JSON results return structured data for APIs and AJAX.

Basic JSON result:

public function execute()
{
    $data = [
        'status' => 'success',
        'message' => 'Product saved',
        'data' => [
            'id' => $product->getId(),
            'name' => $product->getName()
        ]
    ];
    
    $json = $this->resultFactory->create(
        \Magento\Framework\Controller\Result\Json::class
    );
    $json->setData($data);
    
    return $json;
}

JSON with HTTP status code:

public function execute()
{
    $response = $this->resultFactory->create(
        \Magento\Framework\Controller\Result\Json::class
    );
    
    $response->setData([
        'error' => true,
        'message' => 'Validation failed'
    ]);
    
    $response->setHttpResponseCode(422);
    
    return $response;
}

JSON for AJAX form submission:

public function execute()
{
    if (!$this->getRequest()->isAjax()) {
        return $this->_redirect('*/*/index');
    }
    
    try {
        $this->service->process($this->getRequest()->getParams());
        
        $result = $this->resultFactory->create(
            \Magento\Framework\Controller\Result\Json::class
        );
        $result->setData([
            'success' => true,
            'message' => __('Saved successfully')
        ]);
        
        return $result;
    } catch (\Exception $e) {
        $result = $this->resultFactory->create(
            \Magento\Framework\Controller\Result\Json::class
        );
        $result->setData([
            'success' => false,
            'message' => $e->getMessage()
        ]);
        $result->setHttpResponseCode(500);
        
        return $result;
    }
}

Redirect and raw results for special response needs.

Redirect result:

public function execute()
{
    // Redirect to URL
    $redirect = $this->resultFactory->create(
        \Magento\Framework\Controller\Result\Redirect::class
    );
    $redirect->setUrl('https://example.com/page');
    
    return $redirect;
}

Redirect with parameters:

public function execute()
{
    $redirect = $this->resultFactory->create(
        \Magento\Framework\Controller\Result\Redirect::class
    );
    
    // Redirect to controller action
    $redirect->setPath('vendor_module/controller/action', [
        'id' => $id,
        '_current' => true // Keep current params
    ]);
    
    return $redirect;
}

Raw result:

public function execute()
{
    $raw = $this->resultFactory->create(
        \Magento\Framework\Controller\Result\Raw::class
    );
    
    $raw->setContents('Plain text content');
    $raw->setHttpHeaders([
        'Content-Type' => 'text/plain',
        'Content-Disposition' => 'inline'
    ]);
    
    return $raw;
}

Forward result:

public function execute()
{
    $forward = $this->resultFactory->create(
        \Magento\Framework\Controller\Result\Forward::class
    );
    
    $forward->setModule('vendor_module');
    $forward->setController('other_controller');
    $forward->setAction('other_action');
    $forward->setParams(['id' => $id]);
    
    return $forward;
}