<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <link rel="stylesheet" href="../../../../../static/styles.css?h=ae0cc228">
  <link rel="stylesheet" href="../../../../../static/pygments.css">
  <link rel="shortcut icon" href="../../../../../static/favicon.png?h=fa09bedd">
  <title>url_to | Documentation | Lektor Static Content Management System</title>
</head>
<body class="default">
  <nav class="navbar navbar-inverse navbar-static-top">
    <div class="container">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed"
          data-toggle="collapse" data-target="#navbar"
          aria-expanded="false" aria-controls="navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="../../../../../">Lektor</a>
      </div>
      <div id="navbar" class="collapse navbar-collapse">
        <ul class="nav navbar-nav">
          
            <li><a href="../../../../../downloads/">Download</a></li>
          
            <li class="active"><a href="../../../../">Documentation</a></li>
          
            <li><a href="../../../../../showcase/">Showcase</a></li>
          
            <li><a href="../../../../../plugins/">Plugins</a></li>
          
            <li><a href="../../../../../community/">Community</a></li>
          
            <li><a href="../../../../../blog/">Blog</a></li>
          
        </ul>
      </div>
    </div>
  </nav>

  <div class="body-wrapper">
    
    <div class="container">
      
  <div class="row">
    <div class="col-sm-3">
      <ul class="tree-nav nocontent">
        <li><a href="../../../../">Welcome</a></li>
        
        
          <li><a href="../../../../what/">What is Lektor</a>
            
        
          <li><a href="../../../../installation/">Installation</a>
            
        
          <li><a href="../../../../quickstart/">Quickstart</a>
            
        
          <li><a href="../../../../project/">Project</a>
            
        
          <li><a href="../../../../content/">Content</a>
            
        
          <li><a href="../../../../templates/">Templates</a>
            
        
          <li><a href="../../../../themes/">Themes</a>
            
        
          <li><a href="../../../../guides/">Guides</a>
            
        
          <li><a href="../../../../deployment/">Deployment</a>
            
        
          <li><a href="../../../../plugins/">Plugins</a>
            
        
          <li><a href="../../../../models/">Data Modelling</a>
            
        
          <li><a href="../../../../cli/">Command Line</a>
            
        
          <li><a href="../../../">API</a>
            
            <ul>
          <li><a href="../../../build/">Build System</a>
            
        
          <li><a href="../../../databags/">Databags</a>
            
        
          <li><a href="../../">Database</a>
            
            <ul>
          <li><a href="../../asset/">Asset</a>
            
        
          <li><a href="../../types/">Builtin Field Types</a>
            
        
          <li><a href="../../expression/">Expression</a>
            
        
          <li><a href="../../f/">F</a>
            
        
          <li><a href="../../get-alts/">get_alts()</a>
            
        
          <li><a href="../../pad/">Pad</a>
            
        
          <li><a href="../../query/">Query</a>
            
        
          <li><a href="../../record/">Record</a>
            
        
          <li><a href="../">SourceObject</a>
            
            <ul>
          <li><a href="../alt/">alt</a>
            
        
          <li><a href="../is-child-of/">is_child_of()</a>
            
        
          <li><a href="../is-discoverable/">is_discoverable</a>
            
        
          <li><a href="../is-hidden/">is_hidden</a>
            
        
          <li><a href="../is-undiscoverable/">is_undiscoverable</a>
            
        
          <li><a href="../is-visible/">is_visible</a>
            
        
          <li><a href="../parent/">parent</a>
            
        
          <li><a href="../path/">path</a>
            
        
          <li><a href="../record/">record</a>
            
        
          <li><a href="../source-filename/">source_filename</a>
            
        
          <li><a href="../url-path/">url_path</a>
            
        
          <li class="active"><a href="./">url_to()</a>
            
            <ul></ul>
            
        </ul>
            
        
          <li><a href="../../system-fields/">System Fields</a>
            
        
          <li><a href="../../type/">Type</a>
            
        </ul>
            
        
          <li><a href="../../../environment/">Environment</a>
            
        
          <li><a href="../../../plugins/">Plugins</a>
            
        
          <li><a href="../../../project/">Project</a>
            
        
          <li><a href="../../../publisher/">Publisher</a>
            
        
          <li><a href="../../../templates/">Template API</a>
            
        
          <li><a href="../../../utils/">Utilities</a>
            
        </ul>
            
        
          <li><a href="../../../../search/">Search</a>
            
        
      </ul>

      
      <div class="visible-md-block visible-lg-block">
        <h4>This Page</h4>
        <ul class="toc">
        
          <li><a href="#example">Example</a></li>
        
        </ul>
      </div>
      
    </div>

    <div class="col-sm-9 doc-styling">
      
  
    <h1><i class="glyphicon glyphicon-cog"></i> <code class="obj">url_to</code>
        <span class="sig">(<code>path,</code> <code>alt=None,</code> <code>absolute=None,</code> <code>external=None,</code> <code>base_url=None,</code> <code>resolve=None,</code> <code>strict_resolve=None</code>)</span></h1>
  


      <ul class=page-meta>
      
        <li>Method of <a href="../">SourceObject</a></li>
      
      
      
      </ul>

      <p>Calculates the URL from the current source object to the given other source
object.  Alternatively, a path can also be provided instead of a source object.</p>
<p>This is what the <a href="../../../templates/filters/url/"><code>|url</code> filter</a> uses
internally to generate URLs.</p>
<p>If <code>resolve</code> is not <code>False</code>, then (so long as <code>path</code> is not a URL
containing either a <em>scheme</em> or a <em>netloc</em>) an attempt is made to
resolve <code>path</code> via the <a href="../../">Lektor database</a> to a <em>source object</em>,
then the URL of that source object is used.  If database-resolution of
the path fails, then the path is interpreted as a URL-path, or, if
<code>strict_resolve</code> is <code>True</code>, an error is raised.</p>
<p>If the path starts with a leading bang (<code>!</code>) then no resolving is
performed.  This is equivalent to passing <code>resolve=False</code>.</p>
<p>An explicit value for <code>alt</code> may be specified via the <code>alt</code> parameter to <code>url_to</code>.
Alternatively, an <code>alt</code> query arg may be included in the <code>path</code> parameter.
For example, <code>src.url_to('/', alt='de')</code> is equivalent to <code>src.url_to('/?alt=de')</code> — both return the URL to the root of the site with <code>alt=de</code>.</p>
<p>If no <code>alt</code> is provided the <code>alt</code> of the page is used.</p>
<p>In addition to that <code>absolute</code> can enforce the URL to be absolute instead of
relative to the current page and <code>external</code> can be used to also add the
domain part to the URL (if configured).  The default behavior is to use the
configured URL style (which is <code>relative</code>) unless absolute or external were
explicitly provided.  For more information read about this in the
<a href="../../../../project/file/#project" class="ref">Project Configuration</a>.</p>
<h2 id="example">Example</h2><div class="hll"><pre><span></span><span class="cp">{%</span> <span class="k">set</span> <span class="nv">downloads</span> <span class="o">=</span> <span class="nv">site.get</span><span class="o">(</span><span class="s1">&#39;/downloads&#39;</span><span class="o">)</span> <span class="cp">%}</span>
Path from downloads to here: <span class="cp">{{</span> <span class="nv">downloads.url_to</span><span class="o">(</span><span class="nv">this</span><span class="o">)</span> <span class="cp">}}</span>
</pre></div>

      

      

      

      
      <div class="comment-box">
        <h2>Comments</h2>
        
<div id="disqus_thread"></div>
<script>
  var disqus_config = function() { this.page.identifier = "/docs/api/db/obj/url-to"; this.page.url = "https://www.getlektor.com/docs/api/db/obj/url-to/"; };
  (function() {
    var d = document, s = d.createElement('script');
    s.src = '//lektordocumentation.disqus.com/embed.js';
    s.setAttribute('data-timestamp', +new Date());
    (d.head || d.body).appendChild(s);
  })();
</script>
<noscript>
  Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript"
    rel="nofollow">comments powered by Disqus.</a>
</noscript>

      </div>
      
    </div>
  </div>

    </div>
    
  </div>

  
  <div class="bottomsummary">
    <div class="container">
    </div>
  </div>
  

  
  <footer>
    <div class="container">
      <div class="row">
        <div class="col-sm-4 icon-bar">
          <a href="https://github.com/lektor/lektor/" title="Lektor on GitHub"
            ><i class="fa fa-github"></i></a>
          <a href="https://github.com/lektor/lektor/issues/" title="Report Issues for Lektor"
            ><i class="fa fa-bug"></i></a>
          <a href="https://twitter.com/getlektor" title="Find Lektor on Twitter"
            ><i class="fa fa-twitter"></i></a>
          <a href="https://gitter.im/lektor/lektor" title="Chat on Gitter"
            ><i class="fa fa-comment"></i></a>
          <a href="https://github.com/lektor/lektor-website/tree/master/content/docs/api/db/obj/url-to/contents.lr" title="View source for this page"><i class="fa fa-code"></i></a>
        </div>
        <div class="col-sm-8">
          <a href="../../../../../license/">License & Copyright</a> •
          <a href="../../../../../contact/">Contact</a> •
          Made with <i class="fa fa-fw fa-heart" title="Heart"><span hidden>Heart</span></i> in Carinthia
        </div>
      </div>
    </div>
  </footer>
  

  <script type=text/javascript src="../../../../../static/app.js?h=bb1b933a" charset="utf-8"></script>
  <script>
    ((window.gitter = {}).chat = {}).options = {
      room: 'lektor/lektor',
      activationElement: null
    };
    document.write('<button class="js-gitter-toggle-chat-button">Toggle Chat</button>');
    var dnt = navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack;
    if (dnt != "1" && dnt != "yes") {
    window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
      ga('create', 'UA-70822533-1', 'auto');
      ga('set', 'anonymizeIp', true);
      ga('send', 'pageview');
    } else {
      console.debug("Respecting Do-Not-Track, not running analytics.");
    }
  </script>
  <script async src='https://www.google-analytics.com/analytics.js'></script>
  <script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script>
  <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
  <script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
</body>
</html>