instance method to_query

Ruby on Rails edge

Since v5.0.7.2

Available in: v5.0.7.2 v5.1.7 v5.2.8.1 v6.0.6.1 v6.1.7.10 v7.0.10 v7.1.6 v7.2.4 v8.0.5.1 v8.1.4 edge

Signature

to_query(*args)

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

query string:

    params = ActionController::Parameters.new({
      name: "David",
      nationality: "Danish"
    })
    params.to_query
    # => ActionController::UnfilteredParameters: unable to convert unpermitted parameters to hash

    safe_params = params.permit(:name, :nationality)
    safe_params.to_query
    # => "name=David&nationality=Danish"

An optional namespace can be passed to enclose key names:

    params = ActionController::Parameters.new({
      name: "David",
      nationality: "Danish"
    })
    safe_params = params.permit(:name, :nationality)
    safe_params.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.

: (*String?) -> String

Parameters

args rest
Source
# File actionpack/lib/action_controller/metal/strong_parameters.rb, line 390
    def to_query(*args)
      to_h.to_query(*args)
    end

Defined in actionpack/lib/action_controller/metal/strong_parameters.rb line 390 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActionController::Parameters

Type at least 2 characters to search.

Use the arrow keys to navigate results, Enter to open one, Escape to close.

Keyboard shortcuts

/
Focus search
⌘K / Ctrl-K
Command palette
?
This help
Esc
Close