Skip to Content Skip to Search

module AbstractController::Translation

Public instance methods

Alias for: localize.

Also aliased as: l.

Delegates to I18n.localize.

Source code GitHub
# File actionpack/lib/abstract_controller/translation.rb, line 37
def localize(object, **options)
  I18n.localize(object, **options)
end

Alias for: translate.

Also aliased as: t.

Delegates to I18n.translate.

When the given key starts with a period, it will be scoped by the current controller and action. So if you call translate(".foo") from PeopleController#index, it will convert the call to I18n.translate("people.index.foo"). This makes it less repetitive to translate many keys within the same controller / action and gives you a simple framework for scoping them consistently.

Source code GitHub
# File actionpack/lib/abstract_controller/translation.rb, line 17
def translate(key, **options)
  if key&.start_with?(".")
    path = controller_path.tr("/", ".")
    defaults = [:"#{path}#{key}"]
    defaults << options[:default] if options[:default]
    options[:default] = defaults.flatten
    key = "#{path}.#{action_name}#{key}"
  end

  if options[:default] && ActiveSupport::HtmlSafeTranslation.html_safe_translation_key?(key)
    options[:default] = Array(options[:default]).map do |value|
      value.is_a?(String) ? ERB::Util.html_escape(value) : value
    end
  end

  ActiveSupport::HtmlSafeTranslation.translate(key, **options)
end

Definition files