php8.5
Home/ Manual/ yaf / yaf_request_abstract/ Yaf_Request_Abstract::isHead

Yaf_Request_Abstract::isHead

PHP function Edit on GitHub ✎

(Yaf >=1.0.0)

Determine if the request is a HEAD request

Description

Yaf_Request_Abstract::isHead(): bool

Checks whether the request was sent with the HEAD method.

Parameters Parameters

Return Values

Returns true if the request method is HEAD, false otherwise.

Examples

Yaf_Request_Abstract::isHead example

php
<?php
class FeedController extends Yaf_Controller_Abstract
{
    public function indexAction()
    {
        // Assuming the request was sent with HEAD /feed
        if ($this->getRequest()->isHead()) {
            // Headers only, skip rendering the body
            return false;
        }
    }
}
?>

See Also

  • Yaf_Request_Abstract::isGet
  • Yaf_Request_Abstract::isPost
  • Yaf_Request_Abstract::isPut
  • Yaf_Request_Abstract::isOptions
  • Yaf_Request_Abstract::isDelete
  • Yaf_Request_Abstract::isPatch
  • Yaf_Request_Abstract::isCli
  • Yaf_Request_Abstract::isXmlHttpRequest

Source: reference/yaf/yaf_request_abstract/ishead.xml · from the official PHP manual (php/doc-en)