<!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>Set the password for the active archive</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ziparchive.setexternalattributesname.html">ZipArchive::setExternalAttributesName</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ziparchive.statindex.html">ZipArchive::statIndex</a></div>
<div class="up"><a href="class.ziparchive.html">ZipArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="ziparchive.setpassword" class="refentry">
<div class="refnamediv">
<h1 class="refname">ZipArchive::setPassword</h1>
<p class="verinfo">(PHP 5 >= 5.6.0, PHP 7, PECL zip >= 1.12.4)</p><p class="refpurpose"><span class="refname">ZipArchive::setPassword</span> — <span class="dc-title">Set the password for the active archive</span></p>
</div>
<div class="refsect1 description" id="refsect1-ziparchive.setpassword-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>ZipArchive::setPassword</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$password</code></span>
)</div>
<p class="para rdfs-comment">
Sets the password for the active archive.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-ziparchive.setpassword-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">password</code></dt>
<dd>
<p class="para">
The password to be used for the archive.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-ziparchive.setpassword-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 notes" id="refsect1-ziparchive.setpassword-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
As of PHP 7.2.0 and libzip 1.2.0 the password is used to decompress the archive,
and is also the default password for <span class="methodname"><a href="ziparchive.setencryptionname.html" class="methodname">ZipArchive::setEncryptionName()</a></span>
and <span class="methodname"><a href="ziparchive.setencryptionindex.html" class="methodname">ZipArchive::setEncryptionIndex()</a></span>.
Formerly, this function only set the password to be used to decompress the archive;
it did not turn a non-password-protected <a href="class.ziparchive.html" class="classname">ZipArchive</a>
into a password-protected <a href="class.ziparchive.html" class="classname">ZipArchive</a>.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-ziparchive.setpassword-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="methodname"><a href="ziparchive.setencryptionindex.html" class="methodname" rel="rdfs-seeAlso">ZipArchive::setEncryptionIndex()</a> - Set the encryption method of an entry defined by its index</span></li>
<li class="member"><span class="methodname"><a href="ziparchive.setencryptionname.html" class="methodname" rel="rdfs-seeAlso">ZipArchive::setEncryptionName()</a> - Set the encryption method of an entry defined by its name</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ziparchive.setexternalattributesname.html">ZipArchive::setExternalAttributesName</a></div>
<div class="next" style="text-align: right; float: right;"><a href="ziparchive.statindex.html">ZipArchive::statIndex</a></div>
<div class="up"><a href="class.ziparchive.html">ZipArchive</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
