request_filesystem_credentials( string $form_post, string $type = '', bool|WP_Error $error = false, string $context = '', array $extra_fields = null, bool $allow_relaxed_file_ownership = false ): bool|array

Description

Parameters

$form_poststring

The URL to post the form to.

$typestringoptional

Chosen type of filesystem. Default empty.Default: ''

$errorbool|WP_Erroroptional

Whether the current request has failed to connect, or an error object. Default false.Default: false

$contextstringoptional

Full path to the directory that is tested for being writable. Default empty.Default: ''

$extra_fieldsarrayoptional

Extra POST fields to be checked for inclusion in the post. Default null.Default: null

$allow_relaxed_file_ownershipbooloptional

Whether to allow Group/World writable. Default false.Default: false

Return

bool|array

True if no filesystem credentials are required, false if they are required but have not been provided, array of credentials if they are required and have been provided.

Hooks fired · 2

2 hooks fire while request_filesystem_credentials() runs, in this order:

1. 1
   apply_filters( request_filesystem_credentials )filterline 2395 (+25 into the body)

   Filters the filesystem credentials.

2. 2
   apply_filters( fs_ftp_connection_types )filterline 2549 (+179 into the body)

   Filters the connection types to output to the filesystem credentials form.

Uses · 19

• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_filesystem_method()Determines which method to use for reading, writing, modifying, or deleting files on the filesystem.
• get_option()Retrieves an option value based on an option name.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• wp_verify_nonce()Verifies that a correct security nonce was used with time limit.
• wp_installing()Checks or sets whether WordPress is in "installation" mode.
• update_option()Updates the value of an option that was already added.
• __()Retrieves the translation of $text.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• esc_html()Escaping for HTML blocks.
• wp_admin_notice()Outputs an admin notice.
• esc_url()Checks and cleans a URL.

Used by · 12

• WP_Customize_Manager::customize_pane_settings()Prints JavaScript settings for parent window.
• WP_REST_Plugins_Controller::is_filesystem_available()Determine if the endpoints are available.
• WP_Site_Health::get_test_update_temp_backup_writable()Tests if plugin and theme temporary backup directories are writable or can be created.
• WP_Upgrader::maintenance_mode()Toggles maintenance mode for the site.
• WP_Upgrader_Skin::request_filesystem_credentials()Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem.
• _wp_delete_all_temp_backups()Deletes all contents in the temporary backup directory.
• delete_plugins()Removes directory and files of a plugin for a list of plugins.
• delete_theme()Removes a theme.
• do_core_upgrade()Upgrades WordPress core display.
• wp_ajax_delete_plugin()Handles deleting a plugin via AJAX.
• wp_ajax_delete_theme()Handles deleting a theme via AJAX.
• wp_print_request_filesystem_credentials_modal()Prints the filesystem credentials modal when needed.

Source

View on Trac ↗View on GitHub ↗

2370function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) {2371	global $pagenow;2372 2373	/**2374	 * Filters the filesystem credentials.2375	 *2376	 * Returning anything other than an empty string will effectively short-circuit2377	 * output of the filesystem credentials form, returning that value instead.2378	 *2379	 * A filter should return true if no filesystem credentials are required, false if they are required but have not been2380	 * provided, or an array of credentials if they are required and have been provided.2381	 *2382	 * @since 2.5.02383	 * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.2384	 *2385	 * @param mixed         $credentials                  Credentials to return instead. Default empty string.2386	 * @param string        $form_post                    The URL to post the form to.2387	 * @param string        $type                         Chosen type of filesystem.2388	 * @param bool|WP_Error $error                        Whether the current request has failed to connect,2389	 *                                                    or an error object.2390	 * @param string        $context                      Full path to the directory that is tested for2391	 *                                                    being writable.2392	 * @param array         $extra_fields                 Extra POST fields.2393	 * @param bool          $allow_relaxed_file_ownership Whether to allow Group/World writable.2394	 */2395	$req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );2396 2397	if ( '' !== $req_cred ) {2398		return $req_cred;2399	}2400 2401	if ( empty( $type ) ) {2402		$type = get_filesystem_method( array(), $context, $allow_relaxed_file_ownership );2403	}2404 2405	if ( 'direct' === $type ) {2406		return true;2407	}2408 2409	if ( is_null( $extra_fields ) ) {2410		$extra_fields = array( 'version', 'locale' );2411	}2412 2413	$credentials = get_option(2414		'ftp_credentials',2415		array(2416			'hostname' => '',2417			'username' => '',2418		)2419	);2420 2421	$submitted_form = wp_unslash( $_POST );2422 2423	// Verify nonce, or unset submitted form field values on failure.2424	if ( ! isset( $_POST['_fs_nonce'] ) || ! wp_verify_nonce( $_POST['_fs_nonce'], 'filesystem-credentials' ) ) {2425		unset(2426			$submitted_form['hostname'],2427			$submitted_form['username'],2428			$submitted_form['password'],2429			$submitted_form['public_key'],2430			$submitted_form['private_key'],2431			$submitted_form['connection_type']2432		);2433	}2434 2435	$ftp_constants = array(2436		'hostname'    => 'FTP_HOST',2437		'username'    => 'FTP_USER',2438		'password'    => 'FTP_PASS',2439		'public_key'  => 'FTP_PUBKEY',2440		'private_key' => 'FTP_PRIKEY',2441	);2442 2443	/*2444	 * If defined, set it to that. Else, if POST'd, set it to that. If not, set it to an empty string.2445	 * Otherwise, keep it as it previously was (saved details in option).2446	 */2447	foreach ( $ftp_constants as $key => $constant ) {2448		if ( defined( $constant ) ) {2449			$credentials[ $key ] = constant( $constant );

History

Introduced in 2.5.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.9.7 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.