Search and replace tool: Difference between revisions

From MoodleDocs

(Additional tools may be found elsewhere in the admin settings)

No edit summary
(Added an example of using the CLI as there was no indication of syntax or path on this page.)
 
(7 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Admin tools}}
{{Admin tools}}
Admins can search and replace text e.g. URLs in their Moodle database using the search and replace tool at <nowiki>http://yourmoodlesite.org/admin/tool/replace/index.php</nowiki> (replacing yourmoodlesite.org with the address of your Moodle site). This is useful when a [[Moodle migration|Moodle site is moved from one server to another]].
Admins can search and replace text e.g. URLs in their Moodle database using the search and replace tool at <nowiki>http://yourmoodlesite.org/admin/tool/replace/index.php</nowiki> (replacing yourmoodlesite.org with the address of your Moodle site). This is useful when a [[Moodle migration|Moodle site is moved from one server to another]] or when the URL changes.


Note: ''A database backup is highly recommended before running the search and replace'' ;-)
Alternatively, a command line script can be used to search and replace text. See [[Administration via command line]] for details.


See [[Administration via command line]] for more information on command line tools.
{{Warning|A database and site backup should be created before performing a search and replace.}}


==CLI Parameters==
The following parameters can be utilized with the Search and Replace cli sript.


Options:


--search=STRING      String to search for.
--replace=STRING      String to replace with.
--shorten            Shorten result if necessary.
--non-interactive    Perform the replacement without confirming.
-h, --help            Print out this help.
Example:
cd /path/to/your/moodle/dir
php admin/tool/replace/cli/replace.php --search=//oldsitehost --replace=//newsitehost --shorten --non-interactive


==See also==
==See also==
Line 15: Line 31:
[[es:Herramienta para buscar y remplazar]]
[[es:Herramienta para buscar y remplazar]]
[[fr: Recherche et remplacement]]
[[fr: Recherche et remplacement]]
[[de:Datenbank-Suche]]

Latest revision as of 11:57, 6 March 2024

Admins can search and replace text e.g. URLs in their Moodle database using the search and replace tool at http://yourmoodlesite.org/admin/tool/replace/index.php (replacing yourmoodlesite.org with the address of your Moodle site). This is useful when a Moodle site is moved from one server to another or when the URL changes.

Alternatively, a command line script can be used to search and replace text. See Administration via command line for details.

Warning: A database and site backup should be created before performing a search and replace.


CLI Parameters

The following parameters can be utilized with the Search and Replace cli sript.

Options:

--search=STRING String to search for.

--replace=STRING String to replace with.

--shorten Shorten result if necessary.

--non-interactive Perform the replacement without confirming.

-h, --help Print out this help.

Example:

cd /path/to/your/moodle/dir
php admin/tool/replace/cli/replace.php --search=//oldsitehost --replace=//newsitehost --shorten --non-interactive

See also

  • Tracker issue MDL-35099 Convert hidden search/replace script into a proper core admin tool