WordPress/Guide/Administration Screens/Plugins Editor Screen

From SETV Springfield Technical Wiki
Jump to: navigation, search

Plugins → Editor

Among the many user editable files in a standard WordPress installation are the Plugin files. Though it should be rare that you need to change a Plugin code, the Plugins Editor Screen allows you to edit those Plugin files.

Plugins Editor Screen

Back to Administration Screens.

Edit Plugins

The built-in Plugins Editor allows you to view or change any Plugin PHP code in the large text (or edit) box that dominates this Screen.

If a particular file is writeable (see Changing File Permissions), you can make changes and save the file from here. If not, you will see the message You need to make this file writable before you can save your changes. See the Codex for more information.

The name of the Plugin file being edited shows up at the top of the text box. Since Plugin files are pure text, no images or pictures can be inserted into the text box.

Plugin Selection Menu

You can select a Plugin to edit from the dropdown menu on the top right. Just find a Plugin name and click "Select."

Plugin Files
Below the Plugin Selection Menu is a list of the Plugin files that can be edited. Click on any of the file links to place the text of that file in the text box.
Be very careful editing activated plugin files. The editor does not make backup copies. If you introduce an error that crashes your site, you cannot use the editor to fix the problem. In such a case, use FTP to either upload a functional backup of the problem file or change the folder name of the /plugins/ folder under /wp-content/, which effectively deactivates all plugins until the folder is renamed correctly.
Documentation Lookup
Under the editor, there is a dropdown menu listing function names found in the Plugin file you are editing. By selecting a function and clicking the "Lookup" button, you can view its documentation on developer.wordpress.org/reference (WordPress functions) or php.net (PHP functions).

Update File

Remember to click this button to save the changes you have made to the Plugin file. After clicking this button you should see a splash message at the top of the screen saying "File edited successfully." If you don't see that message, then your changes are not saved! Note that if a file is not writeable the Update File button will not be available.

See also Administration Screens and Network Admin.