method

to_query

Ruby on Rails latest stable (v7.1.3.2) - 0 notes - Class: Hash

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

to_query(namespace = nil) public

Returns a string representation of the receiver suitable for use as a URL query string:

{name: 'David', nationality: 'Danish'}.to_query
# => "name=David&nationality=Danish"

An optional namespace can be passed to enclose key names:

{name: 'David', nationality: 'Danish'}.to_query('user')
# => "user%5Bname%5D=David&user%5Bnationality%5D=Danish"

The string pairs “key=value” that conform the query string are sorted lexicographically in ascending order.

Show source

# File activesupport/lib/active_support/core_ext/object/to_query.rb, line 75
  def to_query(namespace = nil)
    query = filter_map do |key, value|
      unless (value.is_a?(Hash) || value.is_a?(Array)) && value.empty?
        value.to_query(namespace ? "#{namespace}[#{key}]" : key)
      end
    end

    query.sort! unless namespace.to_s.include?("[]")
    query.join("&")
  end

to_query

Related methods