<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.strings.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.str-pad.php',
    1 => 'str_pad',
    2 => '使用另一个字符串填充字符串为指定长度',
  ),
  'up' => 
  array (
    0 => 'ref.strings.php',
    1 => '字符串 函数',
  ),
  'prev' => 
  array (
    0 => 'function.str-ireplace.php',
    1 => 'str_ireplace',
  ),
  'next' => 
  array (
    0 => 'function.str-repeat.php',
    1 => 'str_repeat',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/strings/functions/str-pad.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.str-pad" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">str_pad</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.1, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">str_pad</span> &mdash; <span class="dc-title">使用另一个字符串填充字符串为指定长度</span></p>

 </div>
 
 <div class="refsect1 description" id="refsect1-function.str-pad-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>str_pad</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$string</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$pad_string</code><span class="initializer"> = &quot; &quot;</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$pad_type</code><span class="initializer"> = <strong><code><a href="string.constants.php#constant.str-pad-right">STR_PAD_RIGHT</a></code></strong></span></span><br>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>

  <p class="para rdfs-comment">
   该函数返回 <code class="parameter">string</code> 被从左端、右端或者同时两端被填充到制定长度后的结果。如果可选的 <code class="parameter">pad_string</code>
   参数没有被指定，<code class="parameter">string</code> 将被空格字符填充，否则它将被 <code class="parameter">pad_string</code> 填充到指定长度。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.str-pad-parameters">
  <h3 class="title">参数</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">string</code></dt>
     <dd>
      <p class="para">
       输入字符串。
      </p>
     </dd>
    
    
     <dt><code class="parameter">length</code></dt>
     <dd>
      <p class="para">
       填充字符串到最后的长度。
       如果 <code class="parameter">length</code> 的值是负数，小于或者等于输入字符串的长度，不会发生任何填充，并会返回 <code class="parameter">string</code>。
      </p>
     </dd>
    
    
     <dt><code class="parameter">pad_string</code></dt>
     <dd>
      <blockquote class="note"><p><strong class="note">注意</strong>: 
       <p class="para">
        如果填充字符的长度不能被 <code class="parameter">pad_string</code> 整除，那么 <code class="parameter">pad_string</code> 可能会被缩短。
       </p>
      </p></blockquote>
     </dd>
    
    
     <dt><code class="parameter">pad_type</code></dt>
     <dd>
      <p class="para">
       可选的 <code class="parameter">pad_type</code> 参数的可能值为 <strong><code><a href="string.constants.php#constant.str-pad-right">STR_PAD_RIGHT</a></code></strong>，<strong><code><a href="string.constants.php#constant.str-pad-left">STR_PAD_LEFT</a></code></strong> 或 <strong><code><a href="string.constants.php#constant.str-pad-both">STR_PAD_BOTH</a></code></strong>。如果没有指定 <code class="parameter">pad_type</code>，则假定它是 <strong><code><a href="string.constants.php#constant.str-pad-right">STR_PAD_RIGHT</a></code></strong>。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.str-pad-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="para">
   返回填充后的字符串。
  </p>
 </div>



 <div class="refsect1 examples" id="refsect1-function.str-pad-examples">
  <h3 class="title">示例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>示例 #1 <span class="function"><strong>str_pad()</strong></span> 示例</strong></p>
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$input </span><span style="color: #007700">= </span><span style="color: #DD0000">"Alien"</span><span style="color: #007700">;<br />echo </span><span style="color: #0000BB">str_pad</span><span style="color: #007700">(</span><span style="color: #0000BB">$input</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;                      </span><span style="color: #FF8000">// 输出 "Alien     "<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">str_pad</span><span style="color: #007700">(</span><span style="color: #0000BB">$input</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #DD0000">"-="</span><span style="color: #007700">, </span><span style="color: #0000BB">STR_PAD_LEFT</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;  </span><span style="color: #FF8000">// 输出 "-=-=-Alien"<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">str_pad</span><span style="color: #007700">(</span><span style="color: #0000BB">$input</span><span style="color: #007700">, </span><span style="color: #0000BB">10</span><span style="color: #007700">, </span><span style="color: #DD0000">"_"</span><span style="color: #007700">, </span><span style="color: #0000BB">STR_PAD_BOTH</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;   </span><span style="color: #FF8000">// 输出 "__Alien___"<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">str_pad</span><span style="color: #007700">(</span><span style="color: #0000BB">$input</span><span style="color: #007700">,  </span><span style="color: #0000BB">6</span><span style="color: #007700">, </span><span style="color: #DD0000">"___"</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;               </span><span style="color: #FF8000">// 输出 "Alien_"<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">str_pad</span><span style="color: #007700">(</span><span style="color: #0000BB">$input</span><span style="color: #007700">,  </span><span style="color: #0000BB">3</span><span style="color: #007700">, </span><span style="color: #DD0000">"*"</span><span style="color: #007700">), </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;                 </span><span style="color: #FF8000">// 输出 "Alien"<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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

 
 <div class="refsect1 seealso" id="refsect1-function.str-pad-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.mb-str-pad.php" class="function" rel="rdfs-seeAlso">mb_str_pad()</a> - Pad a multibyte string to a certain length with another multibyte string</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>