/usr/share/doc/php-twig/manual/tags/include.html is in php-twig-doc 2.4.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>include — php-twig-doc 2.4.6 documentation</title>
<link rel="stylesheet" href="../_static/classic.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.4.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="macro" href="macro.html" />
<link rel="prev" title="import" href="import.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="macro.html" title="macro"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="import.html" title="import"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">php-twig-doc 2.4.6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Tags</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="include">
<h1><code class="docutils literal"><span class="pre">include</span></code><a class="headerlink" href="#include" title="Permalink to this headline">ΒΆ</a></h1>
<p>The <code class="docutils literal"><span class="pre">include</span></code> statement includes a template and returns the rendered content
of that file into the current namespace:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">include</span> <span class="s1">'header.html'</span> <span class="cp">%}</span><span class="x"></span>
<span class="x"> Body</span>
<span class="cp">{%</span> <span class="k">include</span> <span class="s1">'footer.html'</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>Included templates have access to the variables of the active context.</p>
<p>If you are using the filesystem loader, the templates are looked for in the
paths defined by it.</p>
<p>You can add additional variables by passing them after the <code class="docutils literal"><span class="pre">with</span></code> keyword:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="c">{# template.html will have access to the variables from the current context and the additional ones provided #}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">include</span> <span class="s1">'template.html'</span> <span class="k">with</span> <span class="o">{</span><span class="s1">'foo'</span><span class="o">:</span> <span class="s1">'bar'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">set</span> <span class="nv">vars</span> <span class="o">=</span> <span class="o">{</span><span class="s1">'foo'</span><span class="o">:</span> <span class="s1">'bar'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">include</span> <span class="s1">'template.html'</span> <span class="k">with</span> <span class="nv">vars</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>You can disable access to the context by appending the <code class="docutils literal"><span class="pre">only</span></code> keyword:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="c">{# only the foo variable will be accessible #}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">include</span> <span class="s1">'template.html'</span> <span class="k">with</span> <span class="o">{</span><span class="s1">'foo'</span><span class="o">:</span> <span class="s1">'bar'</span><span class="o">}</span> <span class="nv">only</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="c">{# no variables will be accessible #}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">include</span> <span class="s1">'template.html'</span> <span class="nv">only</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<div class="admonition tip">
<p class="first admonition-title">Tip</p>
<p class="last">When including a template created by an end user, you should consider
sandboxing it. More information in the <a class="reference internal" href="../api.html"><span class="doc">Twig for Developers</span></a>
chapter and in the <a class="reference internal" href="sandbox.html"><span class="doc">sandbox</span></a> tag documentation.</p>
</div>
<p>The template name can be any valid Twig expression:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">include</span> <span class="nv">some_var</span> <span class="cp">%}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">include</span> <span class="nv">ajax</span> <span class="p">?</span> <span class="s1">'ajax.html'</span> <span class="o">:</span> <span class="s1">'not_ajax.html'</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>And if the expression evaluates to a <code class="docutils literal"><span class="pre">Twig_Template</span></code> or a
<code class="docutils literal"><span class="pre">Twig_TemplateWrapper</span></code> instance, Twig will use it directly:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>// {% include template %}
$template = $twig->load('some_template.twig');
$twig->display('template.twig', array('template' => $template));
</pre></div>
</div>
<p>You can mark an include with <code class="docutils literal"><span class="pre">ignore</span> <span class="pre">missing</span></code> in which case Twig will ignore
the statement if the template to be included does not exist. It has to be
placed just after the template name. Here some valid examples:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">include</span> <span class="s1">'sidebar.html'</span> <span class="k">ignore missing</span> <span class="cp">%}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">include</span> <span class="s1">'sidebar.html'</span> <span class="k">ignore missing</span> <span class="k">with</span> <span class="o">{</span><span class="s1">'foo'</span><span class="o">:</span> <span class="s1">'bar'</span><span class="o">}</span> <span class="cp">%}</span><span class="x"></span>
<span class="cp">{%</span> <span class="k">include</span> <span class="s1">'sidebar.html'</span> <span class="k">ignore missing</span> <span class="nv">only</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>You can also provide a list of templates that are checked for existence before
inclusion. The first template that exists will be included:</p>
<div class="highlight-jinja"><div class="highlight"><pre><span></span><span class="cp">{%</span> <span class="k">include</span> <span class="o">[</span><span class="s1">'page_detailed.html'</span><span class="o">,</span> <span class="s1">'page.html'</span><span class="o">]</span> <span class="cp">%}</span><span class="x"></span>
</pre></div>
</div>
<p>If <code class="docutils literal"><span class="pre">ignore</span> <span class="pre">missing</span></code> is given, it will fall back to rendering nothing if none
of the templates exist, otherwise it will throw an exception.</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="import.html"
title="previous chapter"><code class="docutils literal"><span class="pre">import</span></code></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="macro.html"
title="next chapter"><code class="docutils literal"><span class="pre">macro</span></code></a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/tags/include.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="macro.html" title="macro"
>next</a> |</li>
<li class="right" >
<a href="import.html" title="import"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">php-twig-doc 2.4.6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="index.html" >Tags</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright by the Twig Team.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
</div>
</body>
</html>
|