{"id":1183,"date":"2021-04-18T05:07:19","date_gmt":"2021-04-18T05:07:19","guid":{"rendered":"https:\/\/phptutorial.net\/?page_id=1183"},"modified":"2021-09-04T11:08:20","modified_gmt":"2021-09-04T11:08:20","slug":"php-rename-file","status":"publish","type":"page","link":"https:\/\/www.phptutorial.net\/php-tutorial\/php-rename-file\/","title":{"rendered":"PHP Rename File"},"content":{"rendered":"\n<p><strong>Summary<\/strong>: in this tutorial, you will learn how to rename a file in PHP by using the <code>rename()<\/code> function.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id='introduction-to-the-php-rename-file-function'>Introduction to the PHP rename file function <a href=\"#introduction-to-the-php-rename-file-function\" class=\"anchor\" id=\"introduction-to-the-php-rename-file-function\" title=\"Anchor for Introduction to the PHP rename file function\">#<\/a><\/h2>\n\n\n\n<p>To rename a file to the new one, you use the <code>rename()<\/code> function:<\/p>\n\n\n<pre class=\"wp-block-code\" aria-describedby=\"shcb-language-1\" data-shcb-language-name=\"PHP\" data-shcb-language-slug=\"php\"><span><code class=\"hljs language-php\">rename ( string $oldname , string $newname , resource $context = ? ) : bool<\/code><\/span><small class=\"shcb-language\" id=\"shcb-language-1\"><span class=\"shcb-language__label\">Code language:<\/span> <span class=\"shcb-language__name\">PHP<\/span> <span class=\"shcb-language__paren\">(<\/span><span class=\"shcb-language__slug\">php<\/span><span class=\"shcb-language__paren\">)<\/span><\/small><\/pre>\n\n\n<p>The <code>rename()<\/code> function has three parameters:<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li><code>$oldname<\/code> is the name of the file that you want to rename.<\/li><li><code>$newname<\/code> is the new name of the file.<\/li><li><code>$context<\/code> is a valid context resource<\/li><\/ul>\n\n\n\n<p>The rename() function returns true if the $oldname file is renamed successfully or false otherwise.<\/p>\n\n\n\n<p>If the <code>$oldname<\/code> file and <code>$newname<\/code> has a different directory, the <code>rename()<\/code> function will move the file from the current directory to the new one and rename the file.<\/p>\n\n\n\n<p>Note that in case the <code>$newname<\/code> file already exists, the <code>rename()<\/code> function will overwrite it by the <code>$oldname<\/code> file.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\" id='php-rename-file-examples'>PHP rename file examples <a href=\"#php-rename-file-examples\" class=\"anchor\" id=\"php-rename-file-examples\" title=\"Anchor for PHP rename file examples\">#<\/a><\/h2>\n\n\n\n<p>Let&#8217;s take some examples of renaming a file in PHP<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id='1-simple-php-rename-file-example'>1) Simple PHP rename file example <a href=\"#1-simple-php-rename-file-example\" class=\"anchor\" id=\"1-simple-php-rename-file-example\" title=\"Anchor for 1) Simple PHP rename file example\">#<\/a><\/h3>\n\n\n\n<p>The following example uses the <code>rename()<\/code> function to  rename the <code>readme.txt<\/code> file to <code>readme_v2.txt<\/code> file in the same directory:<\/p>\n\n\n<pre class=\"wp-block-code\" aria-describedby=\"shcb-language-2\" data-shcb-language-name=\"HTML, XML\" data-shcb-language-slug=\"xml\"><span><code class=\"hljs language-xml\"><span class=\"php\"><span class=\"hljs-meta\">&lt;?php<\/span>\n\n$oldname = <span class=\"hljs-string\">'readme.txt'<\/span>;\n$newname = <span class=\"hljs-string\">'readme_v2.txt'<\/span>;\n\n<span class=\"hljs-keyword\">if<\/span> (rename($oldname, $newname)) {\n\t$message = sprintf(\n\t\t<span class=\"hljs-string\">'The file %s was renamed to %s successfully!'<\/span>,\n\t\t$oldname,\n\t\t$newname\n\t);\n} <span class=\"hljs-keyword\">else<\/span> {\n\t$message = sprintf(\n\t\t<span class=\"hljs-string\">'There was an error renaming file %s'<\/span>,\n\t\t$oldname\n\t);\n}\n\n<span class=\"hljs-keyword\">echo<\/span> $message;\n<\/span><\/code><\/span><small class=\"shcb-language\" id=\"shcb-language-2\"><span class=\"shcb-language__label\">Code language:<\/span> <span class=\"shcb-language__name\">HTML, XML<\/span> <span class=\"shcb-language__paren\">(<\/span><span class=\"shcb-language__slug\">xml<\/span><span class=\"shcb-language__paren\">)<\/span><\/small><\/pre>\n\n\n<h3 class=\"wp-block-heading\" id='2-rename-and-move-the-file'>2) Rename and move the file <a href=\"#2-rename-and-move-the-file\" class=\"anchor\" id=\"2-rename-and-move-the-file\" title=\"Anchor for 2) Rename and move the file\">#<\/a><\/h3>\n\n\n\n<p>The following example uses the <code>rename()<\/code> function to move the <code>readme.txt<\/code> to the <code>public<\/code> directory and rename it to <code>readme_v3.txt<\/code>:<\/p>\n\n\n<pre class=\"wp-block-code\" aria-describedby=\"shcb-language-3\" data-shcb-language-name=\"HTML, XML\" data-shcb-language-slug=\"xml\"><span><code class=\"hljs language-xml\"><span class=\"php\"><span class=\"hljs-meta\">&lt;?php<\/span>\n\n$oldname = <span class=\"hljs-string\">'readme.txt'<\/span>;\n$newname = <span class=\"hljs-string\">'public\/readme_v3.txt'<\/span>;\n\n<span class=\"hljs-keyword\">if<\/span> (rename($oldname, $newname)) {\n\t$message = sprintf(\n\t\t<span class=\"hljs-string\">'The file %s was renamed to %s successfully!'<\/span>,\n\t\t$oldname,\n\t\t$newname\n\t);\n} <span class=\"hljs-keyword\">else<\/span> {\n\t$message = sprintf(\n\t\t<span class=\"hljs-string\">'There was an error renaming file %s'<\/span>,\n\t\t$oldname\n\t);\n}\n\n<span class=\"hljs-keyword\">echo<\/span> $message;<\/span><\/code><\/span><small class=\"shcb-language\" id=\"shcb-language-3\"><span class=\"shcb-language__label\">Code language:<\/span> <span class=\"shcb-language__name\">HTML, XML<\/span> <span class=\"shcb-language__paren\">(<\/span><span class=\"shcb-language__slug\">xml<\/span><span class=\"shcb-language__paren\">)<\/span><\/small><\/pre>\n\n\n<h3 class=\"wp-block-heading\" id='3-php-rename-multiple-files-helper-function'>3) PHP rename multiple files helper function <a href=\"#3-php-rename-multiple-files-helper-function\" class=\"anchor\" id=\"3-php-rename-multiple-files-helper-function\" title=\"Anchor for 3) PHP rename multiple files helper function\">#<\/a><\/h3>\n\n\n\n<p>The following example <a href=\"https:\/\/phptutorial.net\/php-tutorial\/php-functions\/\">defines a function<\/a> that allows you to rename multiple files. The <code>rename_files()<\/code> function renames the files that match a pattern. It replaces a substring in the filenames with a new string.<\/p>\n\n\n<pre class=\"wp-block-code\" aria-describedby=\"shcb-language-4\" data-shcb-language-name=\"HTML, XML\" data-shcb-language-slug=\"xml\"><span><code class=\"hljs language-xml\"><span class=\"php\"><span class=\"hljs-meta\">&lt;?php<\/span>\r\n\r\n<span class=\"hljs-function\"><span class=\"hljs-keyword\">function<\/span> <span class=\"hljs-title\">rename_files<\/span><span class=\"hljs-params\">(string $pattern, string $search, string $replace)<\/span> : <span class=\"hljs-title\">array<\/span>\r\n<\/span>{\r\n\t$paths = glob($pattern);\r\n\r\n\t$results = &#91;];\r\n\r\n\t<span class=\"hljs-keyword\">foreach<\/span> ($paths <span class=\"hljs-keyword\">as<\/span> $path) {\r\n\t\t<span class=\"hljs-comment\">\/\/ check if the pathname is a file<\/span>\r\n\t\t<span class=\"hljs-keyword\">if<\/span> (!is_file($path)) {\r\n\t\t    $results&#91;$path] = <span class=\"hljs-keyword\">false<\/span>;\r\n\t\t\t<span class=\"hljs-keyword\">continue<\/span>;\r\n\t\t}\r\n\t\t<span class=\"hljs-comment\">\/\/ get the dir and filename<\/span>\r\n\t\t$dirname = dirname($path);\r\n\t\t$filename = basename($path);\r\n\r\n\t\t<span class=\"hljs-comment\">\/\/ replace $search by $replace in the filename<\/span>\r\n\t\t$new_path = $dirname . <span class=\"hljs-string\">'\/'<\/span> . str_replace($search, $replace, $filename);\r\n\r\n\t\t<span class=\"hljs-comment\">\/\/ check if the new file exists<\/span>\r\n\t\t<span class=\"hljs-keyword\">if<\/span> (file_exists($new_path)) {\r\n\t\t    $results&#91;$path] = <span class=\"hljs-keyword\">false<\/span>;\r\n\t\t\t<span class=\"hljs-keyword\">continue<\/span>;\r\n\t\t}\r\n\r\n\t\t<span class=\"hljs-comment\">\/\/ rename the file<\/span>\r\n\t\t$results&#91;$path] = rename($path, $new_path);\r\n\t}\r\n\t<span class=\"hljs-keyword\">return<\/span> $results;\r\n}<\/span><\/code><\/span><small class=\"shcb-language\" id=\"shcb-language-4\"><span class=\"shcb-language__label\">Code language:<\/span> <span class=\"shcb-language__name\">HTML, XML<\/span> <span class=\"shcb-language__paren\">(<\/span><span class=\"shcb-language__slug\">xml<\/span><span class=\"shcb-language__paren\">)<\/span><\/small><\/pre>\n\n\n<p>How it works.<\/p>\n\n\n\n<ul class=\"wp-block-list\"><li>First, get the paths that match a pattern by using the <code>glob()<\/code> function. The <code>glob()<\/code> function returns an array of files (or directories) that match a pattern.<\/li><li>Second, for each path, check if it is a file before renaming.<\/li><\/ul>\n\n\n\n<p>The following uses the <code>replace_files()<\/code> function to rename all the <code>*.md<\/code> files in the <code>pages<\/code> directory to the <code>*.html<\/code> files:<\/p>\n\n\n<pre class=\"wp-block-code\" aria-describedby=\"shcb-language-5\" data-shcb-language-name=\"HTML, XML\" data-shcb-language-slug=\"xml\"><span><code class=\"hljs language-xml\"><span class=\"php\"><span class=\"hljs-meta\">&lt;?php<\/span>\n\nrename_files(<span class=\"hljs-string\">'pages\/*.md'<\/span>, <span class=\"hljs-string\">'.md'<\/span>, <span class=\"hljs-string\">'.html'<\/span>);<\/span><\/code><\/span><small class=\"shcb-language\" id=\"shcb-language-5\"><span class=\"shcb-language__label\">Code language:<\/span> <span class=\"shcb-language__name\">HTML, XML<\/span> <span class=\"shcb-language__paren\">(<\/span><span class=\"shcb-language__slug\">xml<\/span><span class=\"shcb-language__paren\">)<\/span><\/small><\/pre>\n\n\n<h2 class=\"wp-block-heading\" id='summary'>Summary <a href=\"#summary\" class=\"anchor\" id=\"summary\" title=\"Anchor for Summary\">#<\/a><\/h2>\n\n\n\n<ul class=\"wp-block-list\"><li>Use the PHP <code>rename()<\/code>  file function to rename a file.<\/li><\/ul>\n<div class=\"helpful-block-content\" data-title=\"\">\n\t<header>\n\t\t<div class=\"wth-question\">Did you find this tutorial useful?<\/div>\n\t\t<div class=\"wth-thumbs\">\n\t\t\t<button\n\t\t\t\tdata-post=\"1183\"\n\t\t\t\tdata-post-url=\"https:\/\/www.phptutorial.net\/php-tutorial\/php-rename-file\/\"\n\t\t\t\tdata-post-title=\"PHP Rename File\"\n\t\t\t\tdata-response=\"1\"\n\t\t\t\tclass=\"wth-btn-rounded wth-yes-btn\"\n\t\t\t>\n\t\t\t\t<svg\n\t\t\t\t\txmlns=\"http:\/\/www.w3.org\/2000\/svg\"\n\t\t\t\t\tviewBox=\"0 0 24 24\"\n\t\t\t\t\tfill=\"none\"\n\t\t\t\t\tstroke=\"currentColor\"\n\t\t\t\t\tstroke-width=\"2\"\n\t\t\t\t\tstroke-linecap=\"round\"\n\t\t\t\t\tstroke-linejoin=\"round\"\n\t\t\t\t\tclass=\"feather feather-thumbs-up block w-full h-full\"\n\t\t\t\t>\n\t\t\t\t\t<path\n\t\t\t\t\t\td=\"M14 9V5a3 3 0 0 0-3-3l-4 9v11h11.28a2 2 0 0 0 2-1.7l1.38-9a2 2 0 0 0-2-2.3zM7 22H4a2 2 0 0 1-2-2v-7a2 2 0 0 1 2-2h3\"\n\t\t\t\t\t><\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t<span class=\"sr-only\"> Yes <\/span>\n\t\t\t<\/button>\n\n\t\t\t<button\n\t\t\t\tdata-response=\"0\"\n\t\t\t\tdata-post=\"1183\"\n\t\t\t\tdata-post-url=\"https:\/\/www.phptutorial.net\/php-tutorial\/php-rename-file\/\"\n\t\t\t\tdata-post-title=\"PHP Rename File\"\n\t\t\t\tclass=\"wth-btn-rounded wth-no-btn\"\n\t\t\t>\n\t\t\t\t<svg\n\t\t\t\t\txmlns=\"http:\/\/www.w3.org\/2000\/svg\"\n\t\t\t\t\tviewBox=\"0 0 24 24\"\n\t\t\t\t\tfill=\"none\"\n\t\t\t\t\tstroke=\"currentColor\"\n\t\t\t\t\tstroke-width=\"2\"\n\t\t\t\t\tstroke-linecap=\"round\"\n\t\t\t\t\tstroke-linejoin=\"round\"\n\t\t\t\t>\n\t\t\t\t\t<path\n\t\t\t\t\t\td=\"M10 15v4a3 3 0 0 0 3 3l4-9V2H5.72a2 2 0 0 0-2 1.7l-1.38 9a2 2 0 0 0 2 2.3zm7-13h2.67A2.31 2.31 0 0 1 22 4v7a2.31 2.31 0 0 1-2.33 2H17\"\n\t\t\t\t\t><\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t<span class=\"sr-only\"> No <\/span>\n\t\t\t<\/button>\n\t\t<\/div>\n\t<\/header>\n\n\t<div class=\"wth-form hidden\">\n\t\t<div class=\"wth-form-wrapper\">\n\t\t\t<div class=\"wth-title\"><\/div>\n\t\t\t\n\t\t\t<textarea class=\"wth-message\"><\/textarea>\n\n\t\t\t<button class=\"btn btn-primary wth-btn-submit\">Send<\/button>\n\t\t\t<button class=\"btn wth-btn-cancel\">Cancel<\/button>\n\t\t\n\t\t<\/div>\n\t<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>In this tutorial, you will learn how to rename a file in PHP by using the rename() function.<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":15,"menu_order":151,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-1183","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.phptutorial.net\/wp-json\/wp\/v2\/pages\/1183","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.phptutorial.net\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.phptutorial.net\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.phptutorial.net\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.phptutorial.net\/wp-json\/wp\/v2\/comments?post=1183"}],"version-history":[{"count":4,"href":"https:\/\/www.phptutorial.net\/wp-json\/wp\/v2\/pages\/1183\/revisions"}],"predecessor-version":[{"id":2544,"href":"https:\/\/www.phptutorial.net\/wp-json\/wp\/v2\/pages\/1183\/revisions\/2544"}],"up":[{"embeddable":true,"href":"https:\/\/www.phptutorial.net\/wp-json\/wp\/v2\/pages\/15"}],"wp:attachment":[{"href":"https:\/\/www.phptutorial.net\/wp-json\/wp\/v2\/media?parent=1183"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}