Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
151 lines (92 sloc) 3.35 KB
title type order
URL Parsing
guide
80

Wordsmith provides several helpful methods for working with URLs.

The getUrlParts() function parses a string as a URL and attempts to return an array of component parts — e.g. protocol, hostname, path, etc.

(Several shortcut filters are also available if you only need to extract one specific part.)

You can also parse the video ID out of YouTube URLs. (Vimeo URL parsing coming soon.)

Wordsmith's name parsing methods include:

URL parsing

parseUrl

Parses a string as a URL and returns a hash of its components:

{% parseUrl('https://michael@guidesr.us:42/the-answer/?foo=bar#anchor') %}

#  {
#    'scheme' : 'https'
#    'host' : 'guidesr.us'
#    'port' : 42
#    'user' : 'michael'
#    'pass' : null
#    'path' : 'the-answer'
#    'query' : 'foo=bar'
#    'fragment' : 'anchor'
#  }

This function takes after PHP's parse_url() method, except that it always includes all of the possible components, even if they're empty. Furthermore, the individual components returned by parseUrl are string objects, to preserve chainability.

urlFragment

Returns the fragment component of a URL. (i.e. the part after a hashmark '#', which usually represents an anchor on the target page.)

{{ 'https://michael@guidesr.us:42/the-answer/?foo=bar#anchor' | urlFragment }}

#  'anchor'

urlHost

Returns the host name component of a URL.

{{ 'https://michael@guidesr.us:42/the-answer/?foo=bar#anchor' | urlHost }}

#  'guidesr.us'

urlPass

Returns the password component of a URL, or null if the URL doesn't specify a password.

{{ 'https://michael@guidesr.us:42/the-answer/?foo=bar#anchor' | urlPass }}

#  ''

urlPath

Returns the resource path component of a URL, or null if the URL doesn't specify a path.

{{ 'https://michael@guidesr.us:42/the-answer/?foo=bar#anchor' | urlPath }}

#  '/the-answer/'

urlPort

Returns the port number component of a URL, or null if the URL doesn't specify a port.

(PHP's parse_url() method returns an integer for the port number component. Wordsmith, by contrast, returns a string object, to preserve chainability with other methods.)

{{ 'https://michael@guidesr.us:42/the-answer/?foo=bar#anchor' | urlPort }}

#  '42'

urlQuery

Returns the query string component of a URL, or null if the URL doesn't specify a query.

{{ 'https://michael@guidesr.us:42/the-answer/?foo=bar#anchor' | urlQuery }}

#  'foo=bar'

urlScheme

Returns the protocol component of a URL (e.g. 'http', 'https').

{{ 'https://michael@guidesr.us:42/the-answer/?foo=bar#anchor' | urlScheme }}

#  'https'

urlUser

Returns the user component of a URL, or null if the URL doesn't specify a user.

{{ 'https://michael@guidesr.us:42/the-answer/?foo=bar#anchor' | urlUser }}

#  'michael'

youtubeId

Returns the YouTube video ID from a URL, or null if the source string isn't a YouTube video URL.

{{ 'https://www.youtube.com/watch?v=dQw4w9WgXcQ' | youtubeId }}

#  'dQw4w9WgXcQ'