wp_edit_theme_plugin_file( string[] $args ): true|WP_Error

Description

Parameters

$argsstring[]

Args. Note that all of the arg values are already unslashed. They are, however, coming straight from $_POST and are not validated or sanitized in any way.

• $filestring

  Relative path to file.

• $pluginstring

  Path to the plugin file relative to the plugins directory.

• $themestring

  Theme being edited.

• $newcontentstring

  New content for the file.

• $noncestring

  Nonce.

Return

true|WP_Error

True on success or WP_Error on failure.

Hooks fired · 1

One hook fires while wp_edit_theme_plugin_file() runs, in this order:

1. 1
   apply_filters( https_local_ssl_verify )filterline 543 (+165 into the body)

   Filters whether SSL should be verified for local HTTP API requests.

Uses · 23

• validate_file()Validates a file name and path against an allowed set of rules.
• current_user_can()Returns whether the current user has the specified capability.
• __()Retrieves the translation of $text.
• wp_verify_nonce()Verifies that a correct security nonce was used with time limit.
• get_plugins()Checks the plugins directory and retrieve all plugin files with plugin data.
• get_plugin_files()Gets a list of a plugin's files.
• wp_get_plugin_file_editable_extensions()Gets the list of file extensions that are editable in plugins.
• get_option()Retrieves an option value based on an option name.
• wp_get_theme()Gets a WP_Theme object for a theme.
• wp_get_theme_file_editable_extensions()Gets the list of file extensions that are editable for a given theme.
• get_stylesheet()Retrieves name of the current stylesheet.
• get_template()Retrieves name of the active theme.

Used by · 1

• wp_ajax_edit_theme_plugin_file()Handles editing a theme or plugin file via AJAX.

Source

View on Trac ↗View on GitHub ↗

378function wp_edit_theme_plugin_file( $args ) {379	if ( empty( $args['file'] ) ) {380		return new WP_Error( 'missing_file' );381	}382 383	if ( 0 !== validate_file( $args['file'] ) ) {384		return new WP_Error( 'bad_file' );385	}386 387	if ( ! isset( $args['newcontent'] ) ) {388		return new WP_Error( 'missing_content' );389	}390 391	if ( ! isset( $args['nonce'] ) ) {392		return new WP_Error( 'missing_nonce' );393	}394 395	$file    = $args['file'];396	$content = $args['newcontent'];397 398	$plugin    = null;399	$theme     = null;400	$real_file = null;401 402	if ( ! empty( $args['plugin'] ) ) {403		$plugin = $args['plugin'];404 405		if ( ! current_user_can( 'edit_plugins' ) ) {406			return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit plugins for this site.' ) );407		}408 409		if ( ! wp_verify_nonce( $args['nonce'], 'edit-plugin_' . $file ) ) {410			return new WP_Error( 'nonce_failure' );411		}412 413		if ( ! array_key_exists( $plugin, get_plugins() ) ) {414			return new WP_Error( 'invalid_plugin' );415		}416 417		if ( 0 !== validate_file( $file, get_plugin_files( $plugin ) ) ) {418			return new WP_Error( 'bad_plugin_file_path', __( 'Sorry, that file cannot be edited.' ) );419		}420 421		$editable_extensions = wp_get_plugin_file_editable_extensions( $plugin );422 423		$real_file = WP_PLUGIN_DIR . '/' . $file;424 425		$is_active = in_array(426			$plugin,427			(array) get_option( 'active_plugins', array() ),428			true429		);430 431	} elseif ( ! empty( $args['theme'] ) ) {432		$stylesheet = $args['theme'];433 434		if ( 0 !== validate_file( $stylesheet ) ) {435			return new WP_Error( 'bad_theme_path' );436		}437 438		if ( ! current_user_can( 'edit_themes' ) ) {439			return new WP_Error( 'unauthorized', __( 'Sorry, you are not allowed to edit templates for this site.' ) );440		}441 442		$theme = wp_get_theme( $stylesheet );443		if ( ! $theme->exists() ) {444			return new WP_Error( 'non_existent_theme', __( 'The requested theme does not exist.' ) );445		}446 447		if ( ! wp_verify_nonce( $args['nonce'], 'edit-theme_' . $stylesheet . '_' . $file ) ) {448			return new WP_Error( 'nonce_failure' );449		}450 451		if ( $theme->errors() && 'theme_no_stylesheet' === $theme->errors()->get_error_code() ) {452			return new WP_Error(453				'theme_no_stylesheet',454				__( 'The requested theme does not exist.' ) . ' ' . $theme->errors()->get_error_message()455			);456		}457

History

Introduced in 4.9.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-admin/includes/file.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.