method

head

v8.1.1 - Show latest stable - Class: ActionController::Head

head(status, options = nil)

public

Returns a response that has no content (merely headers). The options argument is interpreted to be a hash of header names and values. This allows you to easily return a response that consists only of significant headers:

head :created, location: person_path(@person)

head :created, location: @person

It can also be used to return exceptional conditions:

return head(:method_not_allowed) unless request.post?
return head(:bad_request) unless valid_request?
render

See `Rack::Utils::SYMBOL_TO_STATUS_CODE` for a full list of valid `status` symbols.

# File actionpack/lib/action_controller/metal/head.rb, line 23
    def head(status, options = nil)
      if status.is_a?(Hash)
        raise ArgumentError, "#{status.inspect} is not a valid value for `status`."
      end

      raise ::AbstractController::DoubleRenderError if response_body

      status ||= :ok

      if options
        location = options.delete(:location)
        content_type = options.delete(:content_type)

        options.each do |key, value|
          headers[key.to_s.split(/[-_]/).each { |v| v[0] = v[0].upcase }.join("-")] = value.to_s
        end
      end

      self.status = status
      self.location = url_for(location) if location

      if include_content?(response_code)
        unless self.media_type
          self.content_type = content_type || ((f = formats) && Mime[f.first]) || :html
        end

        response.charset = false
      end

      self.response_body = ""

      true
    end

head

Related methods