wp_prepare_site_data( array $data, array $defaults, WP_Site|null $old_site = null ): array|WP_Error

Prepares site data for insertion or update in the database.

Contents

Parameters

$data array Required
Associative array of site data passed to the respective function.
See wp_insert_site() for the possibly included data.
More Arguments from wp_insert_site( ... $data ) Data for the new site that should be inserted.
  • domain string
    Site domain. Default empty string.
  • path string
    Site path. Default '/'.
  • network_id int
    The site's network ID. Default is the current network ID.
  • registered string
    When the site was registered, in SQL datetime format. Default is the current time.
  • last_updated string
    When the site was last updated, in SQL datetime format. Default is the value of $registered.
  • public int
    Whether the site is public. Default 1.
  • archived int
    Whether the site is archived. Default 0.
  • mature int
    Whether the site is mature. Default 0.
  • spam int
    Whether the site is spam. Default 0.
  • deleted int
    Whether the site is deleted. Default 0.
  • lang_id int
    The site's language ID. Currently unused. Default 0.
  • user_id int
    User ID for the site administrator. Passed to the wp_initialize_site hook.
  • title string
    Site title. Default is 'Site %d' where %d is the site ID. Passed to the wp_initialize_site hook.
  • options array
    Custom option $key => $value pairs to use. Default empty array. Passed to the wp_initialize_site hook.
  • meta array
    Custom site metadata $key => $value pairs to use. Default empty array.
    Passed to the wp_initialize_site hook.
$defaults array Required
Site data defaults to parse $data against.
$old_site WP_Site|null Optional
Old site object if an update, or null if an insertion.

Default: null

Top ↑

Return

array|WP_Error Site data ready for a database transaction, or WP_Error in case a validation error occurred.

Top ↑

Source

File: wp-includes/ms-site.php. View all references 

function wp_prepare_site_data( $data, $defaults, $old_site = null ) {

	// Maintain backward-compatibility with `$site_id` as network ID.
	if ( isset( $data['site_id'] ) ) {
		if ( ! empty( $data['site_id'] ) && empty( $data['network_id'] ) ) {
			$data['network_id'] = $data['site_id'];
		}
		unset( $data['site_id'] );
	}

	/**
	 * Filters passed site data in order to normalize it.
	 *
	 * @since 5.1.0
	 *
	 * @param array $data Associative array of site data passed to the respective function.
	 *                    See {@see wp_insert_site()} for the possibly included data.
	 */
	$data = apply_filters( 'wp_normalize_site_data', $data );

	$allowed_data_fields = array( 'domain', 'path', 'network_id', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );
	$data                = array_intersect_key( wp_parse_args( $data, $defaults ), array_flip( $allowed_data_fields ) );

	$errors = new WP_Error();

	/**
	 * Fires when data should be validated for a site prior to inserting or updating in the database.
	 *
	 * Plugins should amend the `$errors` object via its `WP_Error::add()` method.
	 *
	 * @since 5.1.0
	 *
	 * @param WP_Error     $errors   Error object to add validation errors to.
	 * @param array        $data     Associative array of complete site data. See {@see wp_insert_site()}
	 *                               for the included data.
	 * @param WP_Site|null $old_site The old site object if the data belongs to a site being updated,
	 *                               or null if it is a new site being inserted.
	 */
	do_action( 'wp_validate_site_data', $errors, $data, $old_site );

	if ( ! empty( $errors->errors ) ) {
		return $errors;
	}

	// Prepare for database.
	$data['site_id'] = $data['network_id'];
	unset( $data['network_id'] );

	return $data;
}

View on Trac View on GitHub

Top ↑

Hooks

Top ↑

Top ↑

Changelog

Changelog
Version Description
5.1.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.