instance method number_to_phone

Ruby on Rails 4.1.16

Since v4.0.13

Available in: 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

Signature

number_to_phone(number, options = {})

Formats a number into a US phone number (e.g., (555) 123-9876). You can customize the format in the options hash.

Options

  • :area_code - Adds parentheses around the area code.

  • :delimiter - Specifies the delimiter to use (defaults to “-”).

  • :extension - Specifies an extension to add to the end of the generated number.

  • :country_code - Sets the country code for the phone number.

Examples

number_to_phone(5551234)                                     # => 555-1234
number_to_phone('5551234')                                   # => 555-1234
number_to_phone(1235551234)                                  # => 123-555-1234
number_to_phone(1235551234, area_code: true)                 # => (123) 555-1234
number_to_phone(1235551234, delimiter: ' ')                  # => 123 555 1234
number_to_phone(1235551234, area_code: true, extension: 555) # => (123) 555-1234 x 555
number_to_phone(1235551234, country_code: 1)                 # => +1-123-555-1234
number_to_phone('123a456')                                   # => 123a456

number_to_phone(1235551234, country_code: 1, extension: 1343, delimiter: '.')
# => +1.123.555.1234 x 1343

Parameters

number req
options opt = {}
Source
# File activesupport/lib/active_support/number_helper.rb, line 43
    def number_to_phone(number, options = {})
      NumberToPhoneConverter.convert(number, options)
    end

Defined in activesupport/lib/active_support/number_helper.rb line 43 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveSupport::NumberHelper

Type at least 2 characters to search.

↑↓ navigate · open · esc close