One of the most recurring support requests we get for YOURLS goes like this: "How do I get a -<\/tt> (or a \/<\/tt>, or a :<\/tt>) into my keywords?" People want pretty customshort URLs like sho.rt\/my-talk<\/tt> or sho.rt\/v2:final<\/tt>, and by default YOURLS won't let them.<\/p>\n
The short answer is "use the get_shorturl_charset<\/tt> filter." The long answer is that, depending on the character, that filter is either the whole solution or just the start of one. Here's why, with the colon as the interesting case.<\/p>\nThe easy case: the hyphen<\/h2>\n
YOURLS ships with a bundled core plugin for the hyphen, and it's trivial code: basically add -<\/tt> to the allowed character set.<\/p>\n So, a lot of people starting to build on this, to add any custom char. The thing is a bit more complicated.<\/p>\n When YOURLS instantiates, amongst first things it evaluates the "request", ie the abc<\/tt> part in sho.rt\/abc<\/tt>.<\/p>\n One of the handy bookmarklets YOURLS has is the "Prefix-n-Shorten" mechanism: just prepend your YOURLS URL to a long URL and shorten it on the fly. So the request can be a full URL, such as sho.rt\/https:\/\/longurl.com\/<\/tt>. When abc is a non ambiguous request, now having a colon becomes ambiguous because it looks like a URL:<\/p>\n Because everything funnels through yourls_get_protocol()<\/tt>, and because that function is filterable (it ends with yourls_apply_filter( 'get_protocol', ... ))<\/tt>, one filter fixes the whole chain. The trick is to teach get_protocol<\/tt> to recognize our own keywords and refuse to treat their colon as a scheme.<\/p>\n The logic of the get_protocol filter, in plain English:<\/p>\n Real URLs survive because they contain a \/<\/tt>, a .<\/tt>, an @<\/tt>, or some other character outside the keyword charset, so they fail that last test and keep their protocol. The bookmarklet still works.<\/p>\n\/\/ Add hyphen to the allowed character set\r\nyourls_add_filter( 'get_shorturl_charset', 'ozh_hyphen_in_charset' );\r\n\r\n\/\/ Unless we are crafting a random keyword\r\nyourls_add_action( 'add_new_link_create_keyword', function() {\r\n yourls_remove_filter( 'get_shorturl_charset', 'ozh_hyphen_in_charset' );\r\n} );\r\n\r\nfunction ozh_hyphen_in_charset( $in ) {\r\n return $in . '-';\r\n}<\/code><\/pre><\/div>\nThen someone asks for a colon<\/h2>\n
$request = yourls_get_request();\r\n\r\n\/\/ if request has a scheme : send to bookmarklet\r\nif ( yourls_get_protocol( $keyword ) ) {\r\n \/\/ ... redirect to \/admin\/index.php?...\r\n yourls_redirect( \/* admin *\/, 302 );\r\n exit;\r\n}<\/code><\/pre><\/div>\nThe plugin to allow colon<\/h2>\n
\/\/ Add the colon to the allowed short URL character set...\r\nyourls_add_filter( 'get_shorturl_charset', 'ozh_colon_in_charset' );\r\nfunction ozh_colon_in_charset( $charset ) {\r\n return $charset . ':';\r\n}\r\n\r\n\/\/ ...unless we are crafting a random keyword, to keep auto-generated keywords colon-free\r\nyourls_add_action( 'add_new_link_create_keyword', function() {\r\n yourls_remove_filter( 'get_shorturl_charset', 'ozh_colon_in_charset' );\r\n} );\r\n\r\n\/\/ Don't let a keyword that contains a colon be mistaken for a URI scheme\r\nyourls_add_filter( 'get_protocol', 'ozh_colon_get_protocol', 10, 2 );\r\nfunction ozh_colon_get_protocol( $protocol, $url ) {\r\n \/\/ Nothing was detected as a protocol: leave as is\r\n if ( $protocol === '' ) {\r\n return $protocol;\r\n }\r\n\r\n \/\/ A genuine "scheme:\/\/..." URL (eg a bookmarklet target): leave as is\r\n if ( str_contains( $protocol, '\/' ) ) {\r\n return $protocol;\r\n }\r\n\r\n \/\/ Here $protocol is a bare "scheme:" with no slashes. If the whole candidate\r\n \/\/ string consists only of valid short URL charset characters, it's one of our\r\n \/\/ keywords (eg "foo:bar"), not a URL: don't treat the colon as a scheme.\r\n $pattern = yourls_make_regexp_pattern( yourls_get_shorturl_charset() );\r\n if ( ! preg_match( '@[^' . $pattern . ']@', $url ) ) {\r\n return '';\r\n }\r\n\r\n return $protocol;\r\n}<\/code><\/pre><\/div>\n\n