<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Changes the current umask</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.touch.html">touch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.unlink.html">unlink</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.umask" class="refentry">
<div class="refnamediv">
<h1 class="refname">umask</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">umask</span> — <span class="dc-title">Changes the current umask</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.umask-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>umask</strong></span>
([ <span class="methodparam"><span class="type">int</span> <code class="parameter">$mask</code></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>umask()</strong></span> sets PHP's umask to
<em><code class="parameter">mask</code></em> & 0777 and returns the old
umask. When PHP is being used as a server module, the umask
is restored when each request is finished.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.umask-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">mask</code></em></span>
<dd>
<p class="para">
The new umask.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.umask-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>umask()</strong></span> without arguments simply returns the
current umask otherwise the old umask is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.umask-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2438">
<p><strong>Example #1 <span class="function"><strong>umask()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$old </span><span style="color: #007700">= </span><span style="color: #0000BB">umask</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">chmod</span><span style="color: #007700">(</span><span style="color: #DD0000">"/path/some_dir/some_file.txt"</span><span style="color: #007700">, </span><span style="color: #0000BB">0755</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">umask</span><span style="color: #007700">(</span><span style="color: #0000BB">$old</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Checking<br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">$old </span><span style="color: #007700">!= </span><span style="color: #0000BB">umask</span><span style="color: #007700">()) {<br /> die(</span><span style="color: #DD0000">'An error occurred while changing back the umask'</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.umask-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Avoid using this function in multithreaded webservers. It is better to
change the file permissions with <span class="function"><a href="function.chmod.html" class="function">chmod()</a></span> after
creating the file. Using <span class="function"><strong>umask()</strong></span> can lead to
unexpected behavior of concurrently running scripts and the webserver
itself because they all use the same umask.
</p>
</p></blockquote>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.touch.html">touch</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.unlink.html">unlink</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
