Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 74fc69384aea5f5712e1d2e5c17bee8ef8128bce / . / user_guide / helpers / url_helper.html
blob: 5063359d73e08bbfa520b757ffa8ef8da9490ad2 [file] [log] [blame]
Andrey Andreevc5769952019-01-16 17:49:35 +0200[diff] [blame]1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7 <meta charset="utf-8">
8 <meta name="viewport" content="width=device-width, initial-scale=1.0">
9
10 <title>URL Helper &mdash; CodeIgniter 3.1.10 documentation</title>
11
12
13
14
15 <link rel="shortcut icon" href="../_static/ci-icon.ico"/>
16
17
18
19 <link href='https://fonts.googleapis.com/css?family=Lato:400,700,400italic,700italic|Roboto+Slab:400,700|Inconsolata:400,700&subset=latin,cyrillic' rel='stylesheet' type='text/css'>
20
21
22
23
24
25
26
27
28
29 <link rel="stylesheet" href="../_static/css/citheme.css" type="text/css" />
30
31
32
33 <link rel="index" title="Index"
34 href="../genindex.html"/>
35 <link rel="search" title="Search" href="../search.html"/>
36 <link rel="top" title="CodeIgniter 3.1.10 documentation" href="../index.html"/>
37 <link rel="up" title="Helpers" href="index.html"/>
38 <link rel="next" title="XML Helper" href="xml_helper.html"/>
39 <link rel="prev" title="Typography Helper" href="typography_helper.html"/>
40
41
42 <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
43
44</head>
45
46<body class="wy-body-for-nav" role="document">
47
48 <div id="nav">
49 <div id="nav_inner">
50
51
52
53 <div id="pulldown-menu" class="ciNav">
54 <ul>
55<li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
56</ul>
57<ul>
58<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
59<li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
60<li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
61<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
62<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
63</ul>
64</li>
65</ul>
66<ul>
67<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
68<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
69<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
70<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
71<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
72<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
73<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
74</ul>
75</li>
76</ul>
77<ul>
78<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
79<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
80<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
81<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
82<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
83</ul>
84</li>
85</ul>
86<ul>
87<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
88<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
89<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
90</ul>
91</li>
92</ul>
93<ul>
94<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
95<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
96<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
97<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
98<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
99<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
100<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
101<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
102<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
103<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
104<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
105<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
106<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
107<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
108<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
109<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
110<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
111<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
112<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
113<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
114<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
115<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
116<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
117<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
118<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
119<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
120<li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
121</ul>
122</li>
123</ul>
124<ul>
125<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
126<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
127<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
128<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
129<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
130<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
131<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
132<li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
133<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
134<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
135<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
136<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
137<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
138<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
139<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
140<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
141<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
142<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
143<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
144<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
145<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
146<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
147<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
148<li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
149<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
150<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
151<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
152<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
153<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
154<li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
155<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
156</ul>
157</li>
158</ul>
159<ul>
160<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
161<li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
162<li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
163<li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
164<li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
165<li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
166<li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
167<li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
168<li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
169<li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
170<li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
171<li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
172<li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
173<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
174<li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
175</ul>
176</li>
177</ul>
178<ul class="current">
179<li class="toctree-l1 current"><a class="reference internal" href="index.html">Helpers</a><ul class="current">
180<li class="toctree-l2"><a class="reference internal" href="array_helper.html">Array Helper</a></li>
181<li class="toctree-l2"><a class="reference internal" href="captcha_helper.html">CAPTCHA Helper</a></li>
182<li class="toctree-l2"><a class="reference internal" href="cookie_helper.html">Cookie Helper</a></li>
183<li class="toctree-l2"><a class="reference internal" href="date_helper.html">Date Helper</a></li>
184<li class="toctree-l2"><a class="reference internal" href="directory_helper.html">Directory Helper</a></li>
185<li class="toctree-l2"><a class="reference internal" href="download_helper.html">Download Helper</a></li>
186<li class="toctree-l2"><a class="reference internal" href="email_helper.html">Email Helper</a></li>
187<li class="toctree-l2"><a class="reference internal" href="file_helper.html">File Helper</a></li>
188<li class="toctree-l2"><a class="reference internal" href="form_helper.html">Form Helper</a></li>
189<li class="toctree-l2"><a class="reference internal" href="html_helper.html">HTML Helper</a></li>
190<li class="toctree-l2"><a class="reference internal" href="inflector_helper.html">Inflector Helper</a></li>
191<li class="toctree-l2"><a class="reference internal" href="language_helper.html">Language Helper</a></li>
192<li class="toctree-l2"><a class="reference internal" href="number_helper.html">Number Helper</a></li>
193<li class="toctree-l2"><a class="reference internal" href="path_helper.html">Path Helper</a></li>
194<li class="toctree-l2"><a class="reference internal" href="security_helper.html">Security Helper</a></li>
195<li class="toctree-l2"><a class="reference internal" href="smiley_helper.html">Smiley Helper</a></li>
196<li class="toctree-l2"><a class="reference internal" href="string_helper.html">String Helper</a></li>
197<li class="toctree-l2"><a class="reference internal" href="text_helper.html">Text Helper</a></li>
198<li class="toctree-l2"><a class="reference internal" href="typography_helper.html">Typography Helper</a></li>
199<li class="toctree-l2 current"><a class="current reference internal" href="#">URL Helper</a></li>
200<li class="toctree-l2"><a class="reference internal" href="xml_helper.html">XML Helper</a></li>
201</ul>
202</li>
203</ul>
204
205 </div>
206
207
208 </div>
209</div>
210<div id="nav2">
211 <a href="#" id="openToc">
212 <img src="data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAARgAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABAMDAwMDBAMDBAYEAwQGBwUEBAUHCAYGBwYGCAoICQkJCQgKCgwMDAwMCgwMDQ0MDBERERERFBQUFBQUFBQUFAEEBQUIBwgPCgoPFA4ODhQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgAKwCaAwERAAIRAQMRAf/EAHsAAQAABwEBAAAAAAAAAAAAAAABAwQFBgcIAgkBAQAAAAAAAAAAAAAAAAAAAAAQAAEDAwICBwYEAgsAAAAAAAIBAwQAEQUSBiEHkROTVNQWGDFBUVIUCHEiMtOUFWGBobHRQlMkZIRVEQEAAAAAAAAAAAAAAAAAAAAA/9oADAMBAAIRAxEAPwDSC+ygkOOaUoKigUCgUCgUCgUCgUCgUCgUCgkuGguIP9FBMFb0Hqg7We+3jlmIqqYFf4ub+/QYlnOR/LqIBKGFUbf8qWv971BytQXXE7Y3Lnm3HsFhp2TaZJAdchRXpIgSpdEJWxJEW3xoKV7F5OMy7JkQn2o7D6w33XGjEAkoiqrJEqIiOIiKuhePCgqp22dyYyS3CyWHnQ5joG61HkRnmnTbaFSMhExRVQRRVJU9iUHjE7ez+fJ0MFipmUNhBV8YUd2SoIV9KkjQla9ltegttBdPLW4/qocL+UTfrMiHW4+P9M71shuyrqaHTcxsl7jegpsji8nh5ZwMvDfgTm0RTjSmjYdFCS6KoOIipdFunCgmNYTMv457MMY6U7iI6oMieDDhRm1VbIhuoOkbqtuK0Hpzb+eZcYZexUxt6UyUqK2cd0SdjtgrhOgijcgERUlJOCIl6CpgbP3blRI8XgMjNARAyKNDfeRBdFDBVUAXgQrqH4pxoJTu2NysY97LP4ac1io5q1InHFeGO24LnVKJuKOkSQ/yKir+rh7aCLG1dzypZQI2FnvTgccYOM3FeN0XWERXAUEFVQgQkUktdLpegm+Td3/Xli/L+S/mYNJIOF9G/wBeLKrZHFb0akG6W1WtQWSg3Dyg5e7V3fipE3O4/wCrktyzYA+ufas2LbZIlmnAT2kvuoN1wft95augilglX/tzP3qCu9O3LL/wV/i5v79BvmTADq14UGu91467Z6U9y0HzH/ncj/U/sT/CgynZG7I2NezpZGUjIycJkYkZSG+uQ81pbBNKLxJfjwoMqZ3/ALYHl35AJ7/cuwHcu5k7r1Q5pHetBjquqVVJWGxj9Zrtcl/Ggy3dHMvauR3HFZj5nHNxSyW5JISYDMoIwx8tFIGHZhPNaykGapr6rUAiicEoMG21lMRj8buPAz8xhJrr7uOeiPTCyAwXUaGR1mgozbTusOsFLEiJ7fbQa/h7gcjy2H3V6xppwDNtUSxCJIqp7valBuWVzJ22xuCROXNNZiJkMtms0DbjUkAZjzoDrTMd9dDRI44ZC2YsrYdKWP2WDT2S3N9dNdlRYrGMYc06IURXSYb0igrpWS485xVNS6nF4rwslkoMwnbpgZLB7bmt5uMweAhDEl4B5uSLzzqTnnyVpW2jaJHRMSIjdDiiotvy3DOE5rYTEbkl5yFn28k7JyG4c7AU2HtLH1uKfaiMPI40CdYbpNtmLdwTSn5rewLNld+7TLdeal4WarWBkbVKBjgdElMJJwAAY5fl4kB3b1fp4XvagsGS3FjJfLzDNtS8aeXx7LzT7TyzByQE5PccRGRC0ZRUDRV6y62vbjagzLmJzS2vuPK43JY6aP1TW6Jz+RIWyFtyC06y3EkiiinAo7YCqfq1AqqnGgsOH3lhZO8d1pmcpB8j5XIm9OYlBJSQ/FSS4427DKO0RC8AlcEMhFdViRR1WDWR5t3WXVuL1d106kG9vdeye2g60+1FDyW0shIcXVpyroXt8I8dfd+NB1vioAdWnD3UF1+gD4UFc6CEKpagxXN43rwJLUHz7yX2c8zokt9uHlsPIhA4aRnnHJTLptIS6CNsY7iASpxUUMkReGpfbQW0vtN5pitvrsN28rwtBD0nc0+/Yft5XhaB6TuaXfsP28rwtA9J3NPv2H7eV4Wgek7mn37D9vK8LQPSdzT79h+3leFoHpO5pd+w/byvC0D0nc0u/Yft5XhaB6TuaXfsP28rwtA9J3NLv2H7eV4Wgek7ml37D9vK8LQPSdzS79h+3leFoHpO5p9+w/byvC0E9r7Reazy2HIYVPxkS/CUHVn26cosxyv2g7h89LYmZSXOenvLEQ1YaQ222RATcQCP8rSGqqA8S02W2pQ6FhMoAIlqCtsnwoCpdKClejI4i3Sgtb+GBxVuNBSFt1pV/RQefLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8uM/JQPLjPyUDy4z8lA8utJ/koJ7WCbBU/LQXOPAFq1koK8B0pag90CggtBBf6qB0UDooHRQOigdFA6KB0UDooHRQOigdFA6KB0UDooI0EaBQf//Z" title="Toggle Table of Contents" alt="Toggle Table of Contents" />
213 </a>
214</div>
215
216 <div class="wy-grid-for-nav">
217
218
219 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
220 <div class="wy-side-nav-search">
221
222 <a href="../index.html" class="fa fa-home"> CodeIgniter</a>
223
224
225<div role="search">
226 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
227 <input type="text" name="q" placeholder="Search docs" />
228 <input type="hidden" name="check_keywords" value="yes" />
229 <input type="hidden" name="area" value="default" />
230 </form>
231</div>
232 </div>
233
234 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
235
236
237
238 <ul>
239<li class="toctree-l1"><a class="reference internal" href="../general/welcome.html">Welcome to CodeIgniter</a></li>
240</ul>
241<ul>
242<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation Instructions</a><ul>
243<li class="toctree-l2"><a class="reference internal" href="../installation/downloads.html">Downloading CodeIgniter</a></li>
244<li class="toctree-l2"><a class="reference internal" href="../installation/index.html">Installation Instructions</a></li>
245<li class="toctree-l2"><a class="reference internal" href="../installation/upgrading.html">Upgrading From a Previous Version</a></li>
246<li class="toctree-l2"><a class="reference internal" href="../installation/troubleshooting.html">Troubleshooting</a></li>
247</ul>
248</li>
249</ul>
250<ul>
251<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">CodeIgniter Overview</a><ul>
252<li class="toctree-l2"><a class="reference internal" href="../overview/getting_started.html">Getting Started</a></li>
253<li class="toctree-l2"><a class="reference internal" href="../overview/at_a_glance.html">CodeIgniter at a Glance</a></li>
254<li class="toctree-l2"><a class="reference internal" href="../overview/features.html">Supported Features</a></li>
255<li class="toctree-l2"><a class="reference internal" href="../overview/appflow.html">Application Flow Chart</a></li>
256<li class="toctree-l2"><a class="reference internal" href="../overview/mvc.html">Model-View-Controller</a></li>
257<li class="toctree-l2"><a class="reference internal" href="../overview/goals.html">Architectural Goals</a></li>
258</ul>
259</li>
260</ul>
261<ul>
262<li class="toctree-l1"><a class="reference internal" href="../tutorial/index.html">Tutorial</a><ul>
263<li class="toctree-l2"><a class="reference internal" href="../tutorial/static_pages.html">Static pages</a></li>
264<li class="toctree-l2"><a class="reference internal" href="../tutorial/news_section.html">News section</a></li>
265<li class="toctree-l2"><a class="reference internal" href="../tutorial/create_news_items.html">Create news items</a></li>
266<li class="toctree-l2"><a class="reference internal" href="../tutorial/conclusion.html">Conclusion</a></li>
267</ul>
268</li>
269</ul>
270<ul>
271<li class="toctree-l1"><a class="reference internal" href="../contributing/index.html">Contributing to CodeIgniter</a><ul>
272<li class="toctree-l2"><a class="reference internal" href="../documentation/index.html">Writing CodeIgniter Documentation</a></li>
273<li class="toctree-l2"><a class="reference internal" href="../DCO.html">Developer’s Certificate of Origin 1.1</a></li>
274</ul>
275</li>
276</ul>
277<ul>
278<li class="toctree-l1"><a class="reference internal" href="../general/index.html">General Topics</a><ul>
279<li class="toctree-l2"><a class="reference internal" href="../general/urls.html">CodeIgniter URLs</a></li>
280<li class="toctree-l2"><a class="reference internal" href="../general/controllers.html">Controllers</a></li>
281<li class="toctree-l2"><a class="reference internal" href="../general/reserved_names.html">Reserved Names</a></li>
282<li class="toctree-l2"><a class="reference internal" href="../general/views.html">Views</a></li>
283<li class="toctree-l2"><a class="reference internal" href="../general/models.html">Models</a></li>
284<li class="toctree-l2"><a class="reference internal" href="../general/helpers.html">Helpers</a></li>
285<li class="toctree-l2"><a class="reference internal" href="../general/libraries.html">Using CodeIgniter Libraries</a></li>
286<li class="toctree-l2"><a class="reference internal" href="../general/creating_libraries.html">Creating Libraries</a></li>
287<li class="toctree-l2"><a class="reference internal" href="../general/drivers.html">Using CodeIgniter Drivers</a></li>
288<li class="toctree-l2"><a class="reference internal" href="../general/creating_drivers.html">Creating Drivers</a></li>
289<li class="toctree-l2"><a class="reference internal" href="../general/core_classes.html">Creating Core System Classes</a></li>
290<li class="toctree-l2"><a class="reference internal" href="../general/ancillary_classes.html">Creating Ancillary Classes</a></li>
291<li class="toctree-l2"><a class="reference internal" href="../general/hooks.html">Hooks - Extending the Framework Core</a></li>
292<li class="toctree-l2"><a class="reference internal" href="../general/autoloader.html">Auto-loading Resources</a></li>
293<li class="toctree-l2"><a class="reference internal" href="../general/common_functions.html">Common Functions</a></li>
294<li class="toctree-l2"><a class="reference internal" href="../general/compatibility_functions.html">Compatibility Functions</a></li>
295<li class="toctree-l2"><a class="reference internal" href="../general/routing.html">URI Routing</a></li>
296<li class="toctree-l2"><a class="reference internal" href="../general/errors.html">Error Handling</a></li>
297<li class="toctree-l2"><a class="reference internal" href="../general/caching.html">Caching</a></li>
298<li class="toctree-l2"><a class="reference internal" href="../general/profiling.html">Profiling Your Application</a></li>
299<li class="toctree-l2"><a class="reference internal" href="../general/cli.html">Running via the CLI</a></li>
300<li class="toctree-l2"><a class="reference internal" href="../general/managing_apps.html">Managing your Applications</a></li>
301<li class="toctree-l2"><a class="reference internal" href="../general/environments.html">Handling Multiple Environments</a></li>
302<li class="toctree-l2"><a class="reference internal" href="../general/alternative_php.html">Alternate PHP Syntax for View Files</a></li>
303<li class="toctree-l2"><a class="reference internal" href="../general/security.html">Security</a></li>
304<li class="toctree-l2"><a class="reference internal" href="../general/styleguide.html">PHP Style Guide</a></li>
305</ul>
306</li>
307</ul>
308<ul>
309<li class="toctree-l1"><a class="reference internal" href="../libraries/index.html">Libraries</a><ul>
310<li class="toctree-l2"><a class="reference internal" href="../libraries/benchmark.html">Benchmarking Class</a></li>
311<li class="toctree-l2"><a class="reference internal" href="../libraries/caching.html">Caching Driver</a></li>
312<li class="toctree-l2"><a class="reference internal" href="../libraries/calendar.html">Calendaring Class</a></li>
313<li class="toctree-l2"><a class="reference internal" href="../libraries/cart.html">Shopping Cart Class</a></li>
314<li class="toctree-l2"><a class="reference internal" href="../libraries/config.html">Config Class</a></li>
315<li class="toctree-l2"><a class="reference internal" href="../libraries/email.html">Email Class</a></li>
316<li class="toctree-l2"><a class="reference internal" href="../libraries/encrypt.html">Encrypt Class</a></li>
317<li class="toctree-l2"><a class="reference internal" href="../libraries/encryption.html">Encryption Library</a></li>
318<li class="toctree-l2"><a class="reference internal" href="../libraries/file_uploading.html">File Uploading Class</a></li>
319<li class="toctree-l2"><a class="reference internal" href="../libraries/form_validation.html">Form Validation</a></li>
320<li class="toctree-l2"><a class="reference internal" href="../libraries/ftp.html">FTP Class</a></li>
321<li class="toctree-l2"><a class="reference internal" href="../libraries/image_lib.html">Image Manipulation Class</a></li>
322<li class="toctree-l2"><a class="reference internal" href="../libraries/input.html">Input Class</a></li>
323<li class="toctree-l2"><a class="reference internal" href="../libraries/javascript.html">Javascript Class</a></li>
324<li class="toctree-l2"><a class="reference internal" href="../libraries/language.html">Language Class</a></li>
325<li class="toctree-l2"><a class="reference internal" href="../libraries/loader.html">Loader Class</a></li>
326<li class="toctree-l2"><a class="reference internal" href="../libraries/migration.html">Migrations Class</a></li>
327<li class="toctree-l2"><a class="reference internal" href="../libraries/output.html">Output Class</a></li>
328<li class="toctree-l2"><a class="reference internal" href="../libraries/pagination.html">Pagination Class</a></li>
329<li class="toctree-l2"><a class="reference internal" href="../libraries/parser.html">Template Parser Class</a></li>
330<li class="toctree-l2"><a class="reference internal" href="../libraries/security.html">Security Class</a></li>
331<li class="toctree-l2"><a class="reference internal" href="../libraries/sessions.html">Session Library</a></li>
332<li class="toctree-l2"><a class="reference internal" href="../libraries/table.html">HTML Table Class</a></li>
333<li class="toctree-l2"><a class="reference internal" href="../libraries/trackback.html">Trackback Class</a></li>
334<li class="toctree-l2"><a class="reference internal" href="../libraries/typography.html">Typography Class</a></li>
335<li class="toctree-l2"><a class="reference internal" href="../libraries/unit_testing.html">Unit Testing Class</a></li>
336<li class="toctree-l2"><a class="reference internal" href="../libraries/uri.html">URI Class</a></li>
337<li class="toctree-l2"><a class="reference internal" href="../libraries/user_agent.html">User Agent Class</a></li>
338<li class="toctree-l2"><a class="reference internal" href="../libraries/xmlrpc.html">XML-RPC and XML-RPC Server Classes</a></li>
339<li class="toctree-l2"><a class="reference internal" href="../libraries/zip.html">Zip Encoding Class</a></li>
340</ul>
341</li>
342</ul>
343<ul>
344<li class="toctree-l1"><a class="reference internal" href="../database/index.html">Database Reference</a><ul>
345<li class="toctree-l2"><a class="reference internal" href="../database/examples.html">Quick Start: Usage Examples</a></li>
346<li class="toctree-l2"><a class="reference internal" href="../database/configuration.html">Database Configuration</a></li>
347<li class="toctree-l2"><a class="reference internal" href="../database/connecting.html">Connecting to a Database</a></li>
348<li class="toctree-l2"><a class="reference internal" href="../database/queries.html">Running Queries</a></li>
349<li class="toctree-l2"><a class="reference internal" href="../database/results.html">Generating Query Results</a></li>
350<li class="toctree-l2"><a class="reference internal" href="../database/helpers.html">Query Helper Functions</a></li>
351<li class="toctree-l2"><a class="reference internal" href="../database/query_builder.html">Query Builder Class</a></li>
352<li class="toctree-l2"><a class="reference internal" href="../database/transactions.html">Transactions</a></li>
353<li class="toctree-l2"><a class="reference internal" href="../database/metadata.html">Getting MetaData</a></li>
354<li class="toctree-l2"><a class="reference internal" href="../database/call_function.html">Custom Function Calls</a></li>
355<li class="toctree-l2"><a class="reference internal" href="../database/caching.html">Query Caching</a></li>
356<li class="toctree-l2"><a class="reference internal" href="../database/forge.html">Database Manipulation with Database Forge</a></li>
357<li class="toctree-l2"><a class="reference internal" href="../database/utilities.html">Database Utilities Class</a></li>
358<li class="toctree-l2"><a class="reference internal" href="../database/db_driver_reference.html">Database Driver Reference</a></li>
359</ul>
360</li>
361</ul>
362<ul class="current">
363<li class="toctree-l1 current"><a class="reference internal" href="index.html">Helpers</a><ul class="current">
364<li class="toctree-l2"><a class="reference internal" href="array_helper.html">Array Helper</a></li>
365<li class="toctree-l2"><a class="reference internal" href="captcha_helper.html">CAPTCHA Helper</a></li>
366<li class="toctree-l2"><a class="reference internal" href="cookie_helper.html">Cookie Helper</a></li>
367<li class="toctree-l2"><a class="reference internal" href="date_helper.html">Date Helper</a></li>
368<li class="toctree-l2"><a class="reference internal" href="directory_helper.html">Directory Helper</a></li>
369<li class="toctree-l2"><a class="reference internal" href="download_helper.html">Download Helper</a></li>
370<li class="toctree-l2"><a class="reference internal" href="email_helper.html">Email Helper</a></li>
371<li class="toctree-l2"><a class="reference internal" href="file_helper.html">File Helper</a></li>
372<li class="toctree-l2"><a class="reference internal" href="form_helper.html">Form Helper</a></li>
373<li class="toctree-l2"><a class="reference internal" href="html_helper.html">HTML Helper</a></li>
374<li class="toctree-l2"><a class="reference internal" href="inflector_helper.html">Inflector Helper</a></li>
375<li class="toctree-l2"><a class="reference internal" href="language_helper.html">Language Helper</a></li>
376<li class="toctree-l2"><a class="reference internal" href="number_helper.html">Number Helper</a></li>
377<li class="toctree-l2"><a class="reference internal" href="path_helper.html">Path Helper</a></li>
378<li class="toctree-l2"><a class="reference internal" href="security_helper.html">Security Helper</a></li>
379<li class="toctree-l2"><a class="reference internal" href="smiley_helper.html">Smiley Helper</a></li>
380<li class="toctree-l2"><a class="reference internal" href="string_helper.html">String Helper</a></li>
381<li class="toctree-l2"><a class="reference internal" href="text_helper.html">Text Helper</a></li>
382<li class="toctree-l2"><a class="reference internal" href="typography_helper.html">Typography Helper</a></li>
383<li class="toctree-l2 current"><a class="current reference internal" href="#">URL Helper</a></li>
384<li class="toctree-l2"><a class="reference internal" href="xml_helper.html">XML Helper</a></li>
385</ul>
386</li>
387</ul>
388
389
390
391 </div>
392 &nbsp;
393 </nav>
394
395 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
396
397
398 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
399 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
400 <a href="../index.html">CodeIgniter</a>
401 </nav>
402
403
404
405 <div class="wy-nav-content">
406 <div class="rst-content">
407 <div role="navigation" aria-label="breadcrumbs navigation">
408 <ul class="wy-breadcrumbs">
409 <li><a href="../index.html">Docs</a> &raquo;</li>
410
411 <li><a href="index.html">Helpers</a> &raquo;</li>
412
413 <li>URL Helper</li>
414 <li class="wy-breadcrumbs-aside">
415
416 </li>
417 <div style="float:right;margin-left:5px;" id="closeMe">
418 <img title="Classic Layout" alt="classic layout" src="data:image/gif;base64,R0lGODlhFAAUAJEAAAAAADMzM////wAAACH5BAUUAAIALAAAAAAUABQAAAImlI+py+0PU5gRBRDM3DxbWoXis42X13USOLauUIqnlsaH/eY6UwAAOw==" />
419 </div>
420 </ul>
421 <hr/>
422</div>
423 <div role="main" class="document">
424
425 <div class="section" id="url-helper">
426<h1>URL Helper<a class="headerlink" href="#url-helper" title="Permalink to this headline"></a></h1>
427<p>The URL Helper file contains functions that assist in working with URLs.</p>
428<div class="contents local topic" id="contents">
429<ul class="simple">
430<li><a class="reference internal" href="#loading-this-helper" id="id1">Loading this Helper</a></li>
431<li><a class="reference internal" href="#available-functions" id="id2">Available Functions</a></li>
432</ul>
433</div>
434<div class="custom-index container"></div><div class="section" id="loading-this-helper">
435<h2><a class="toc-backref" href="#id1">Loading this Helper</a><a class="headerlink" href="#loading-this-helper" title="Permalink to this headline"></a></h2>
436<p>This helper is loaded using the following code:</p>
437<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">load</span><span class="o">-&gt;</span><span class="na">helper</span><span class="p">(</span><span class="s1">&#39;url&#39;</span><span class="p">);</span>
438</pre></div>
439</div>
440</div>
441<div class="section" id="available-functions">
442<h2><a class="toc-backref" href="#id2">Available Functions</a><a class="headerlink" href="#available-functions" title="Permalink to this headline"></a></h2>
443<p>The following functions are available:</p>
444<dl class="function">
445<dt id="site_url">
446<code class="descname">site_url</code><span class="sig-paren">(</span><span class="optional">[</span><em>$uri = ''</em><span class="optional">[</span>, <em>$protocol = NULL</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span><a class="headerlink" href="#site_url" title="Permalink to this definition"></a></dt>
447<dd><table class="docutils field-list" frame="void" rules="none">
448<col class="field-name" />
449<col class="field-body" />
450<tbody valign="top">
451<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
452<li><strong>$uri</strong> (<em>string</em>) – URI string</li>
453<li><strong>$protocol</strong> (<em>string</em>) – Protocol, e.g. ‘http’ or ‘https’</li>
454</ul>
455</td>
456</tr>
457<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Site URL</p>
458</td>
459</tr>
460<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
461</td>
462</tr>
463</tbody>
464</table>
465<p>Returns your site URL, as specified in your config file. The index.php
466file (or whatever you have set as your site <strong>index_page</strong> in your config
467file) will be added to the URL, as will any URI segments you pass to the
468function, plus the <strong>url_suffix</strong> as set in your config file.</p>
469<p>You are encouraged to use this function any time you need to generate a
470local URL so that your pages become more portable in the event your URL
471changes.</p>
472<p>Segments can be optionally passed to the function as a string or an
473array. Here is a string example:</p>
474<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">site_url</span><span class="p">(</span><span class="s1">&#39;news/local/123&#39;</span><span class="p">);</span>
475</pre></div>
476</div>
477<p>The above example would return something like:
478<em>http://example.com/index.php/news/local/123</em></p>
479<p>Here is an example of segments passed as an array:</p>
480<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$segments</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">&#39;news&#39;</span><span class="p">,</span> <span class="s1">&#39;local&#39;</span><span class="p">,</span> <span class="s1">&#39;123&#39;</span><span class="p">);</span>
481<span class="k">echo</span> <span class="nx">site_url</span><span class="p">(</span><span class="nv">$segments</span><span class="p">);</span>
482</pre></div>
483</div>
484<p>This function is an alias for <code class="docutils literal"><span class="pre">CI_Config::site_url()</span></code>. For more info,
485please see the <a class="reference internal" href="../libraries/config.html"><span class="doc">Config Library</span></a> documentation.</p>
486</dd></dl>
487
488<dl class="function">
489<dt id="base_url">
490<code class="descname">base_url</code><span class="sig-paren">(</span><em>$uri = ''</em>, <em>$protocol = NULL</em><span class="sig-paren">)</span><a class="headerlink" href="#base_url" title="Permalink to this definition"></a></dt>
491<dd><table class="docutils field-list" frame="void" rules="none">
492<col class="field-name" />
493<col class="field-body" />
494<tbody valign="top">
495<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
496<li><strong>$uri</strong> (<em>string</em>) – URI string</li>
497<li><strong>$protocol</strong> (<em>string</em>) – Protocol, e.g. ‘http’ or ‘https’</li>
498</ul>
499</td>
500</tr>
501<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Base URL</p>
502</td>
503</tr>
504<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
505</td>
506</tr>
507</tbody>
508</table>
509<p>Returns your site base URL, as specified in your config file. Example:</p>
510<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">base_url</span><span class="p">();</span>
511</pre></div>
512</div>
513<p>This function returns the same thing as <a class="reference internal" href="#site_url" title="site_url"><code class="xref php php-func docutils literal"><span class="pre">site_url()</span></code></a>, without
514the <em>index_page</em> or <em>url_suffix</em> being appended.</p>
515<p>Also like <a class="reference internal" href="#site_url" title="site_url"><code class="xref php php-func docutils literal"><span class="pre">site_url()</span></code></a>, you can supply segments as a string or
516an array. Here is a string example:</p>
517<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">base_url</span><span class="p">(</span><span class="s2">&quot;blog/post/123&quot;</span><span class="p">);</span>
518</pre></div>
519</div>
520<p>The above example would return something like:
521<em>http://example.com/blog/post/123</em></p>
522<p>This is useful because unlike <a class="reference internal" href="#site_url" title="site_url"><code class="xref php php-func docutils literal"><span class="pre">site_url()</span></code></a>, you can supply a
523string to a file, such as an image or stylesheet. For example:</p>
524<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">base_url</span><span class="p">(</span><span class="s2">&quot;images/icons/edit.png&quot;</span><span class="p">);</span>
525</pre></div>
526</div>
527<p>This would give you something like:
528<em>http://example.com/images/icons/edit.png</em></p>
529<p>This function is an alias for <code class="docutils literal"><span class="pre">CI_Config::base_url()</span></code>. For more info,
530please see the <a class="reference internal" href="../libraries/config.html"><span class="doc">Config Library</span></a> documentation.</p>
531</dd></dl>
532
533<dl class="function">
534<dt id="current_url">
535<code class="descname">current_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#current_url" title="Permalink to this definition"></a></dt>
536<dd><table class="docutils field-list" frame="void" rules="none">
537<col class="field-name" />
538<col class="field-body" />
539<tbody valign="top">
540<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The current URL</td>
541</tr>
542<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
543</tr>
544</tbody>
545</table>
546<p>Returns the full URL (including segments) of the page being currently
547viewed.</p>
548<div class="admonition note">
549<p class="first admonition-title">Note</p>
550<p class="last">Calling this function is the same as doing this:
551|
552| site_url(uri_string());</p>
553</div>
554</dd></dl>
555
556<dl class="function">
557<dt id="uri_string">
558<code class="descname">uri_string</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#uri_string" title="Permalink to this definition"></a></dt>
559<dd><table class="docutils field-list" frame="void" rules="none">
560<col class="field-name" />
561<col class="field-body" />
562<tbody valign="top">
563<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">An URI string</td>
564</tr>
565<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
566</tr>
567</tbody>
568</table>
569<p>Returns the URI segments of any page that contains this function.
570For example, if your URL was this:</p>
571<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">http</span><span class="o">://</span><span class="nx">some</span><span class="o">-</span><span class="nx">site</span><span class="o">.</span><span class="nx">com</span><span class="o">/</span><span class="nx">blog</span><span class="o">/</span><span class="nx">comments</span><span class="o">/</span><span class="mi">123</span>
572</pre></div>
573</div>
574<p>The function would return:</p>
575<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nx">blog</span><span class="o">/</span><span class="nx">comments</span><span class="o">/</span><span class="mi">123</span>
576</pre></div>
577</div>
578<p>This function is an alias for <code class="docutils literal"><span class="pre">CI_Config::uri_string()</span></code>. For more info,
579please see the <a class="reference internal" href="../libraries/config.html"><span class="doc">Config Library</span></a> documentation.</p>
580</dd></dl>
581
582<dl class="function">
583<dt id="index_page">
584<code class="descname">index_page</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#index_page" title="Permalink to this definition"></a></dt>
585<dd><table class="docutils field-list" frame="void" rules="none">
586<col class="field-name" />
587<col class="field-body" />
588<tbody valign="top">
589<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">‘index_page’ value</td>
590</tr>
591<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">mixed</td>
592</tr>
593</tbody>
594</table>
595<p>Returns your site <strong>index_page</strong>, as specified in your config file.
596Example:</p>
597<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">index_page</span><span class="p">();</span>
598</pre></div>
599</div>
600</dd></dl>
601
602<dl class="function">
603<dt id="anchor">
604<code class="descname">anchor</code><span class="sig-paren">(</span><em>$uri = ''</em>, <em>$title = ''</em>, <em>$attributes = ''</em><span class="sig-paren">)</span><a class="headerlink" href="#anchor" title="Permalink to this definition"></a></dt>
605<dd><table class="docutils field-list" frame="void" rules="none">
606<col class="field-name" />
607<col class="field-body" />
608<tbody valign="top">
609<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
610<li><strong>$uri</strong> (<em>string</em>) – URI string</li>
611<li><strong>$title</strong> (<em>string</em>) – Anchor title</li>
612<li><strong>$attributes</strong> (<em>mixed</em>) – HTML attributes</li>
613</ul>
614</td>
615</tr>
616<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">HTML hyperlink (anchor tag)</p>
617</td>
618</tr>
619<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
620</td>
621</tr>
622</tbody>
623</table>
624<p>Creates a standard HTML anchor link based on your local site URL.</p>
625<p>The first parameter can contain any segments you wish appended to the
626URL. As with the <a class="reference internal" href="#site_url" title="site_url"><code class="xref php php-func docutils literal"><span class="pre">site_url()</span></code></a> function above, segments can
627be a string or an array.</p>
628<div class="admonition note">
629<p class="first admonition-title">Note</p>
630<p class="last">If you are building links that are internal to your application
631do not include the base URL (http://…). This will be added
632automatically from the information specified in your config file.
633Include only the URI segments you wish appended to the URL.</p>
634</div>
635<p>The second segment is the text you would like the link to say. If you
636leave it blank, the URL will be used.</p>
637<p>The third parameter can contain a list of attributes you would like
638added to the link. The attributes can be a simple string or an
639associative array.</p>
640<p>Here are some examples:</p>
641<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">anchor</span><span class="p">(</span><span class="s1">&#39;news/local/123&#39;</span><span class="p">,</span> <span class="s1">&#39;My News&#39;</span><span class="p">,</span> <span class="s1">&#39;title=&quot;News title&quot;&#39;</span><span class="p">);</span>
642<span class="c1">// Prints: &lt;a href=&quot;http://example.com/index.php/news/local/123&quot; title=&quot;News title&quot;&gt;My News&lt;/a&gt;</span>
643
644<span class="k">echo</span> <span class="nx">anchor</span><span class="p">(</span><span class="s1">&#39;news/local/123&#39;</span><span class="p">,</span> <span class="s1">&#39;My News&#39;</span><span class="p">,</span> <span class="k">array</span><span class="p">(</span><span class="s1">&#39;title&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;The best news!&#39;</span><span class="p">));</span>
645<span class="c1">// Prints: &lt;a href=&quot;http://example.com/index.php/news/local/123&quot; title=&quot;The best news!&quot;&gt;My News&lt;/a&gt;</span>
646
647<span class="k">echo</span> <span class="nx">anchor</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;Click here&#39;</span><span class="p">);</span>
648<span class="c1">// Prints: &lt;a href=&quot;http://example.com&quot;&gt;Click Here&lt;/a&gt;</span>
649</pre></div>
650</div>
651</dd></dl>
652
653<dl class="function">
654<dt id="anchor_popup">
655<code class="descname">anchor_popup</code><span class="sig-paren">(</span><em>$uri = ''</em>, <em>$title = ''</em>, <em>$attributes = FALSE</em><span class="sig-paren">)</span><a class="headerlink" href="#anchor_popup" title="Permalink to this definition"></a></dt>
656<dd><table class="docutils field-list" frame="void" rules="none">
657<col class="field-name" />
658<col class="field-body" />
659<tbody valign="top">
660<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
661<li><strong>$uri</strong> (<em>string</em>) – URI string</li>
662<li><strong>$title</strong> (<em>string</em>) – Anchor title</li>
663<li><strong>$attributes</strong> (<em>mixed</em>) – HTML attributes</li>
664</ul>
665</td>
666</tr>
667<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Pop-up hyperlink</p>
668</td>
669</tr>
670<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
671</td>
672</tr>
673</tbody>
674</table>
675<p>Nearly identical to the <a class="reference internal" href="#anchor" title="anchor"><code class="xref php php-func docutils literal"><span class="pre">anchor()</span></code></a> function except that it
676opens the URL in a new window. You can specify JavaScript window
677attributes in the third parameter to control how the window is opened.
678If the third parameter is not set it will simply open a new window with
679your own browser settings.</p>
680<p>Here is an example with attributes:</p>
681<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$atts</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span>
682 <span class="s1">&#39;width&#39;</span> <span class="o">=&gt;</span> <span class="mi">800</span><span class="p">,</span>
683 <span class="s1">&#39;height&#39;</span> <span class="o">=&gt;</span> <span class="mi">600</span><span class="p">,</span>
684 <span class="s1">&#39;scrollbars&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;yes&#39;</span><span class="p">,</span>
685 <span class="s1">&#39;status&#39;</span><span class="nx">    </span> <span class="nx"> </span><span class="o">=&gt;</span> <span class="s1">&#39;yes&#39;</span><span class="p">,</span>
686 <span class="s1">&#39;resizable&#39;</span><span class="nx"> </span> <span class="nx"> </span><span class="o">=&gt;</span> <span class="s1">&#39;yes&#39;</span><span class="p">,</span>
687 <span class="s1">&#39;screenx&#39;</span> <span class="o">=&gt;</span> <span class="mi">0</span><span class="p">,</span>
688 <span class="s1">&#39;screeny&#39;</span> <span class="o">=&gt;</span> <span class="mi">0</span><span class="p">,</span>
689 <span class="s1">&#39;window_name&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;_blank&#39;</span>
690<span class="p">);</span>
691
692<span class="k">echo</span> <span class="nx">anchor_popup</span><span class="p">(</span><span class="s1">&#39;news/local/123&#39;</span><span class="p">,</span> <span class="s1">&#39;Click Me!&#39;</span><span class="p">,</span> <span class="nv">$atts</span><span class="p">);</span>
693</pre></div>
694</div>
695<div class="admonition note">
696<p class="first admonition-title">Note</p>
697<p class="last">The above attributes are the function defaults so you only need to
698set the ones that are different from what you need. If you want the
699function to use all of its defaults simply pass an empty array in the
700third parameter:
701|
702| echo anchor_popup(‘news/local/123’, ‘Click Me!’, array());</p>
703</div>
704<div class="admonition note">
705<p class="first admonition-title">Note</p>
706<p class="last">The <strong>window_name</strong> is not really an attribute, but an argument to
707the JavaScript <cite>window.open() &lt;http://www.w3schools.com/jsref/met_win_open.asp&gt;</cite>
708method, which accepts either a window name or a window target.</p>
709</div>
710<div class="admonition note">
711<p class="first admonition-title">Note</p>
712<p class="last">Any other attribute than the listed above will be parsed as an
713HTML attribute to the anchor tag.</p>
714</div>
715</dd></dl>
716
717<dl class="function">
718<dt id="mailto">
719<code class="descname">mailto</code><span class="sig-paren">(</span><em>$email</em>, <em>$title = ''</em>, <em>$attributes = ''</em><span class="sig-paren">)</span><a class="headerlink" href="#mailto" title="Permalink to this definition"></a></dt>
720<dd><table class="docutils field-list" frame="void" rules="none">
721<col class="field-name" />
722<col class="field-body" />
723<tbody valign="top">
724<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
725<li><strong>$email</strong> (<em>string</em>) – E-mail address</li>
726<li><strong>$title</strong> (<em>string</em>) – Anchor title</li>
727<li><strong>$attributes</strong> (<em>mixed</em>) – HTML attributes</li>
728</ul>
729</td>
730</tr>
731<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A “mail to” hyperlink</p>
732</td>
733</tr>
734<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
735</td>
736</tr>
737</tbody>
738</table>
739<p>Creates a standard HTML e-mail link. Usage example:</p>
740<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">echo</span> <span class="nx">mailto</span><span class="p">(</span><span class="s1">&#39;me@my-site.com&#39;</span><span class="p">,</span> <span class="s1">&#39;Click Here to Contact Me&#39;</span><span class="p">);</span>
741</pre></div>
742</div>
743<p>As with the <a class="reference internal" href="#anchor" title="anchor"><code class="xref php php-func docutils literal"><span class="pre">anchor()</span></code></a> tab above, you can set attributes using the
744third parameter:</p>
745<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$attributes</span> <span class="o">=</span> <span class="k">array</span><span class="p">(</span><span class="s1">&#39;title&#39;</span> <span class="o">=&gt;</span> <span class="s1">&#39;Mail me&#39;</span><span class="p">);</span>
746<span class="k">echo</span> <span class="nx">mailto</span><span class="p">(</span><span class="s1">&#39;me@my-site.com&#39;</span><span class="p">,</span> <span class="s1">&#39;Contact Me&#39;</span><span class="p">,</span> <span class="nv">$attributes</span><span class="p">);</span>
747</pre></div>
748</div>
749</dd></dl>
750
751<dl class="function">
752<dt id="safe_mailto">
753<code class="descname">safe_mailto</code><span class="sig-paren">(</span><em>$email</em>, <em>$title = ''</em>, <em>$attributes = ''</em><span class="sig-paren">)</span><a class="headerlink" href="#safe_mailto" title="Permalink to this definition"></a></dt>
754<dd><table class="docutils field-list" frame="void" rules="none">
755<col class="field-name" />
756<col class="field-body" />
757<tbody valign="top">
758<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
759<li><strong>$email</strong> (<em>string</em>) – E-mail address</li>
760<li><strong>$title</strong> (<em>string</em>) – Anchor title</li>
761<li><strong>$attributes</strong> (<em>mixed</em>) – HTML attributes</li>
762</ul>
763</td>
764</tr>
765<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A spam-safe “mail to” hyperlink</p>
766</td>
767</tr>
768<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
769</td>
770</tr>
771</tbody>
772</table>
773<p>Identical to the <a class="reference internal" href="#mailto" title="mailto"><code class="xref php php-func docutils literal"><span class="pre">mailto()</span></code></a> function except it writes an obfuscated
774version of the <em>mailto</em> tag using ordinal numbers written with JavaScript to
775help prevent the e-mail address from being harvested by spam bots.</p>
776</dd></dl>
777
778<dl class="function">
779<dt id="auto_link">
780<code class="descname">auto_link</code><span class="sig-paren">(</span><em>$str</em>, <em>$type = 'both'</em>, <em>$popup = FALSE</em><span class="sig-paren">)</span><a class="headerlink" href="#auto_link" title="Permalink to this definition"></a></dt>
781<dd><table class="docutils field-list" frame="void" rules="none">
782<col class="field-name" />
783<col class="field-body" />
784<tbody valign="top">
785<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
786<li><strong>$str</strong> (<em>string</em>) – Input string</li>
787<li><strong>$type</strong> (<em>string</em>) – Link type (‘email’, ‘url’ or ‘both’)</li>
788<li><strong>$popup</strong> (<em>bool</em>) – Whether to create popup links</li>
789</ul>
790</td>
791</tr>
792<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Linkified string</p>
793</td>
794</tr>
795<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
796</td>
797</tr>
798</tbody>
799</table>
800<p>Automatically turns URLs and e-mail addresses contained in a string into
801links. Example:</p>
802<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">auto_link</span><span class="p">(</span><span class="nv">$string</span><span class="p">);</span>
803</pre></div>
804</div>
805<p>The second parameter determines whether URLs and e-mails are converted or
806just one or the other. Default behavior is both if the parameter is not
807specified. E-mail links are encoded as <a class="reference internal" href="#safe_mailto" title="safe_mailto"><code class="xref php php-func docutils literal"><span class="pre">safe_mailto()</span></code></a> as shown
808above.</p>
809<p>Converts only URLs:</p>
810<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">auto_link</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="s1">&#39;url&#39;</span><span class="p">);</span>
811</pre></div>
812</div>
813<p>Converts only e-mail addresses:</p>
814<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">auto_link</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="s1">&#39;email&#39;</span><span class="p">);</span>
815</pre></div>
816</div>
817<p>The third parameter determines whether links are shown in a new window.
818The value can be TRUE or FALSE (boolean):</p>
819<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$string</span> <span class="o">=</span> <span class="nx">auto_link</span><span class="p">(</span><span class="nv">$string</span><span class="p">,</span> <span class="s1">&#39;both&#39;</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span>
820</pre></div>
821</div>
822</dd></dl>
823
824<dl class="function">
825<dt id="url_title">
826<code class="descname">url_title</code><span class="sig-paren">(</span><em>$str</em>, <em>$separator = '-'</em>, <em>$lowercase = FALSE</em><span class="sig-paren">)</span><a class="headerlink" href="#url_title" title="Permalink to this definition"></a></dt>
827<dd><table class="docutils field-list" frame="void" rules="none">
828<col class="field-name" />
829<col class="field-body" />
830<tbody valign="top">
831<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
832<li><strong>$str</strong> (<em>string</em>) – Input string</li>
833<li><strong>$separator</strong> (<em>string</em>) – Word separator</li>
834<li><strong>$lowercase</strong> (<em>bool</em>) – Whether to transform the output string to lower-case</li>
835</ul>
836</td>
837</tr>
838<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">URL-formatted string</p>
839</td>
840</tr>
841<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
842</td>
843</tr>
844</tbody>
845</table>
846<p>Takes a string as input and creates a human-friendly URL string. This is
847useful if, for example, you have a blog in which you’d like to use the
848title of your entries in the URL. Example:</p>
849<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$title</span> <span class="o">=</span> <span class="s2">&quot;What&#39;s wrong with CSS?&quot;</span><span class="p">;</span>
850<span class="nv">$url_title</span> <span class="o">=</span> <span class="nx">url_title</span><span class="p">(</span><span class="nv">$title</span><span class="p">);</span>
851<span class="c1">// Produces: Whats-wrong-with-CSS</span>
852</pre></div>
853</div>
854<p>The second parameter determines the word delimiter. By default dashes
855are used. Preferred options are: <strong>-</strong> (dash) or <strong>_</strong> (underscore)</p>
856<p>Example:</p>
857<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$title</span> <span class="o">=</span> <span class="s2">&quot;What&#39;s wrong with CSS?&quot;</span><span class="p">;</span>
858<span class="nv">$url_title</span> <span class="o">=</span> <span class="nx">url_title</span><span class="p">(</span><span class="nv">$title</span><span class="p">,</span> <span class="s1">&#39;underscore&#39;</span><span class="p">);</span>
859<span class="c1">// Produces: Whats_wrong_with_CSS</span>
860</pre></div>
861</div>
862<div class="admonition note">
863<p class="first admonition-title">Note</p>
864<p class="last">Old usage of ‘dash’ and ‘underscore’ as the second parameter
865is DEPRECATED.</p>
866</div>
867<p>The third parameter determines whether or not lowercase characters are
868forced. By default they are not. Options are boolean TRUE/FALSE.</p>
869<p>Example:</p>
870<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$title</span> <span class="o">=</span> <span class="s2">&quot;What&#39;s wrong with CSS?&quot;</span><span class="p">;</span>
871<span class="nv">$url_title</span> <span class="o">=</span> <span class="nx">url_title</span><span class="p">(</span><span class="nv">$title</span><span class="p">,</span> <span class="s1">&#39;underscore&#39;</span><span class="p">,</span> <span class="k">TRUE</span><span class="p">);</span>
872<span class="c1">// Produces: whats_wrong_with_css</span>
873</pre></div>
874</div>
875</dd></dl>
876
877<dl class="function">
878<dt id="prep_url">
879<code class="descname">prep_url</code><span class="sig-paren">(</span><em>$str = ''</em><span class="sig-paren">)</span><a class="headerlink" href="#prep_url" title="Permalink to this definition"></a></dt>
880<dd><table class="docutils field-list" frame="void" rules="none">
881<col class="field-name" />
882<col class="field-body" />
883<tbody valign="top">
884<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
885<li><strong>$str</strong> (<em>string</em>) – URL string</li>
886</ul>
887</td>
888</tr>
889<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Protocol-prefixed URL string</p>
890</td>
891</tr>
892<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
893</td>
894</tr>
895</tbody>
896</table>
897<p>This function will add http:// in the event that a protocol prefix
898is missing from a URL.</p>
899<p>Pass the URL string to the function like this:</p>
900<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="nv">$url</span> <span class="o">=</span> <span class="nx">prep_url</span><span class="p">(</span><span class="s1">&#39;example.com&#39;</span><span class="p">);</span>
901</pre></div>
902</div>
903</dd></dl>
904
905<dl class="function">
906<dt id="redirect">
907<code class="descname">redirect</code><span class="sig-paren">(</span><em>$uri = ''</em>, <em>$method = 'auto'</em>, <em>$code = NULL</em><span class="sig-paren">)</span><a class="headerlink" href="#redirect" title="Permalink to this definition"></a></dt>
908<dd><table class="docutils field-list" frame="void" rules="none">
909<col class="field-name" />
910<col class="field-body" />
911<tbody valign="top">
912<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
913<li><strong>$uri</strong> (<em>string</em>) – URI string</li>
914<li><strong>$method</strong> (<em>string</em>) – Redirect method (‘auto’, ‘location’ or ‘refresh’)</li>
915<li><strong>$code</strong> (<em>string</em>) – HTTP Response code (usually 302 or 303)</li>
916</ul>
917</td>
918</tr>
919<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
920</td>
921</tr>
922</tbody>
923</table>
924<p>Does a “header redirect” to the URI specified. If you specify the full
925site URL that link will be built, but for local links simply providing
926the URI segments to the controller you want to direct to will create the
927link. The function will build the URL based on your config file values.</p>
928<p>The optional second parameter allows you to force a particular redirection
929method. The available methods are <strong>auto</strong>, <strong>location</strong> and <strong>refresh</strong>,
930with location being faster but less reliable on IIS servers.
931The default is <strong>auto</strong>, which will attempt to intelligently choose the
932method based on the server environment.</p>
933<p>The optional third parameter allows you to send a specific HTTP Response
934Code - this could be used for example to create 301 redirects for search
935engine purposes. The default Response Code is 302. The third parameter is
936<em>only</em> available with <strong>location</strong> redirects, and not <em>refresh</em>. Examples:</p>
937<div class="highlight-ci"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="p">(</span><span class="nv">$logged_in</span> <span class="o">==</span> <span class="k">FALSE</span><span class="p">)</span>
938<span class="p">{</span>
939 <span class="nx">redirect</span><span class="p">(</span><span class="s1">&#39;/login/form/&#39;</span><span class="p">);</span>
940<span class="p">}</span>
941
942<span class="c1">// with 301 redirect</span>
943<span class="nx">redirect</span><span class="p">(</span><span class="s1">&#39;/article/13&#39;</span><span class="p">,</span> <span class="s1">&#39;location&#39;</span><span class="p">,</span> <span class="mi">301</span><span class="p">);</span>
944</pre></div>
945</div>
946<div class="admonition note">
947<p class="first admonition-title">Note</p>
948<p class="last">In order for this function to work it must be used before anything
949is outputted to the browser since it utilizes server headers.</p>
950</div>
951<div class="admonition note">
952<p class="first admonition-title">Note</p>
953<p class="last">For very fine grained control over headers, you should use the
954<a class="reference internal" href="../libraries/output.html"><span class="doc">Output Library</span></a> <code class="docutils literal"><span class="pre">set_header()</span></code> method.</p>
955</div>
956<div class="admonition note">
957<p class="first admonition-title">Note</p>
958<p class="last">To IIS users: if you hide the <cite>Server</cite> HTTP header, the <em>auto</em>
959method won’t detect IIS, in that case it is advised you explicitly
960use the <strong>refresh</strong> method.</p>
961</div>
962<div class="admonition note">
963<p class="first admonition-title">Note</p>
964<p class="last">When the <strong>location</strong> method is used, an HTTP status code of 303
965will <em>automatically</em> be selected when the page is currently accessed
966via POST and HTTP/1.1 is used.</p>
967</div>
968<div class="admonition important">
969<p class="first admonition-title">Important</p>
970<p class="last">This function will terminate script execution.</p>
971</div>
972</dd></dl>
973
974</div>
975</div>
976
977
978 </div>
979 <footer>
980
981 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
982
983 <a href="xml_helper.html" class="btn btn-neutral float-right" title="XML Helper">Next <span class="fa fa-arrow-circle-right"></span></a>
984
985
986 <a href="typography_helper.html" class="btn btn-neutral" title="Typography Helper"><span class="fa fa-arrow-circle-left"></span> Previous</a>
987
988 </div>
989
990
991 <hr/>
992
993 <div role="contentinfo">
994 <p>
995 &copy; Copyright 2014 - 2019, British Columbia Institute of Technology.
996 Last updated on Jan 16, 2019.
997 </p>
998 </div>
999
1000 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
1001
1002</footer>
1003 </div>
1004 </div>
1005
1006 </section>
1007
1008 </div>
1009
1010
1011
1012
1013
1014 <script type="text/javascript">
1015 var DOCUMENTATION_OPTIONS = {
1016 URL_ROOT:'../',
1017 VERSION:'3.1.10',
1018 COLLAPSE_INDEX:false,
1019 FILE_SUFFIX:'.html',
1020 HAS_SOURCE: false
1021 };
1022 </script>
1023 <script type="text/javascript" src="../_static/jquery.js"></script>
1024 <script type="text/javascript" src="../_static/underscore.js"></script>
1025 <script type="text/javascript" src="../_static/doctools.js"></script>
1026
1027
1028
1029
1030
1031 <script type="text/javascript" src="../_static/js/theme.js"></script>
1032
1033
1034
1035
1036 <script type="text/javascript">
1037 jQuery(function () {
1038 SphinxRtdTheme.StickyNav.enable();
1039 });
1040 </script>
1041
1042
1043</body>
1044</html>