How to set a custom response HTTP header for the current controller?

dmitrii_fediuk · November 30, 2015, 5:54pm

Step 1

Get the HTTP response singleton for the current controller.

Step 2

Call the setHeader on it.

magento/magento2/blob/ce68a6d/lib/internal/Magento/Framework/Controller/ResultInterface.php#L24-L35


/**
 * Set a header
 *
 * If $replace is true, replaces any headers already defined with that
 * $name.
 *
 * @param string $name
 * @param string $value
 * @param boolean $replace
 * @return $this
 */
public function setHeader($name, $value, $replace = false);

github.com

magento/magento2/blob/ce68a6d/lib/internal/Magento/Framework/HTTP/PhpEnvironment/Response.php#L78-L98


/**
 * Set a header
 *
 * If $replace is true, replaces any headers already defined with that
 * $name.
 *
 * @param string $name
 * @param string $value
 * @param boolean $replace
 * @return $this
 */
public function setHeader($name, $value, $replace = false)
{
    $value = (string)$value;


    if ($replace) {
        $this->clearHeader($name);
    }


    $this->getHeaders()->addHeaderLine($name, $value);
    return $this;

For example:

$response->setHeader('Content-Transfer-Encoding', 'binary', true);

dmitrii_fediuk · March 31, 2016, 11:05am