method

auto_link

v1.0.0 - Show latest stable - 2 notes - Class: ActionView::Helpers::TextHelper

1.0.0 (0)
1.1.6 (0)
1.2.6 (1)
2.0.3 (13)
2.1.0 (0)
2.2.1 (14)
2.3.8 (0)
3.0.0 (0)
3.0.9 (-1)
3.1.0
3.2.1
3.2.8
3.2.13
4.0.2
4.1.8
4.2.1
4.2.7
4.2.9
5.0.0.1
5.1.7
5.2.3
6.0.0
6.1.3.1
6.1.7.7
7.0.0
7.1.3.2
7.1.3.4
What's this?

auto_link(text, link = :all, href_options = {}, &block) public

Turns all urls and email addresses into clickable links. The link parameter can limit what should be linked. Options are :all (default), :email_addresses, and :urls.

Example:

  auto_link("Go to http://www.rubyonrails.com and say hello to david@loudthinking.com") =>
    Go to <a href="http://www.rubyonrails.com">http://www.rubyonrails.com</a> and
    say hello to <a href="mailto:david@loudthinking.com">david@loudthinking.com</a>

If a block is given, each url and email address is yielded and the result is used as the link text. Example:

  auto_link(post.body, :all, :target => '_blank') do |text|
    truncate(text, 15)
  end

Show source

# File actionpack/lib/action_view/helpers/text_helper.rb, line 144
      def auto_link(text, link = :all, href_options = {}, &block)
        case link
          when :all             then auto_link_urls(auto_link_email_addresses(text, &block), href_options, &block)
          when :email_addresses then auto_link_email_addresses(text, &block)
          when :urls            then auto_link_urls(text, href_options, &block)
        end
      end

August 6, 2009

4 thanks

Documentation bug

When adding the :target option, the documentation states that you should user :href_options like so:

auto_link(post_body, :href_options => { :target => '_blank' })

However, I could only get it to work using :html instead:

auto_link(post_body, :html => { :target => '_blank' })

I’m using Rails 2.2.2, but I believe that this also happens for more recent version .

November 6, 2011 - (>= v3.1.0)

3 thanks

This method (and #auto_link_urls) has been removed in Rails 3.1 - other options are out there, such as Rinku, however there is a gem you can use for migration purposes etc, which is rails_autolink: http://rubygems.org/gems/rails_autolink

auto_link

Related methods

Documentation bug

Removed in 3.1.x