instance method `capture`

Ruby on Rails 7.1.6

Since v2.2.3

Available in: v2.2.3 v2.3.18 v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

capture(*args, &block)

The capture method extracts part of a template as a string object. You can then use this object anywhere in your templates, layout, or helpers.

The capture method can be used in ERB templates…

<% @greeting = capture do %>
  Welcome to my shiny new web page!  The date and time is
  <%= Time.now %>
<% end %>

…and Builder (RXML) templates.

@timestamp = capture do
  "The current timestamp is #{Time.now}."
end

You can then use that variable anywhere else. For example:

<html>
<head><title><%= @greeting %></title></head>
<body>
<b><%= @greeting %></b>
</body>
</html>

The return of capture is the string generated by the block. For Example:

@greeting # => "Welcome to my shiny new web page! The date and time is 2018-09-06 11:09:16 -0500"

Parameters

args rest
block block

Source

# File actionview/lib/action_view/helpers/capture_helper.rb, line 47
      def capture(*args, &block)
        value = nil
        @output_buffer ||= ActionView::OutputBuffer.new
        buffer = @output_buffer.capture { value = yield(*args) }

        string = if @output_buffer.equal?(value)
          buffer
        else
          buffer.presence || value
        end

        case string
        when OutputBuffer
          string.to_s
        when ActiveSupport::SafeBuffer
          string
        when String
          ERB::Util.html_escape(string)
        end
      end

Defined in actionview/lib/action_view/helpers/capture_helper.rb line 47 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionView::Helpers::CaptureHelper

Signature

Parameters