do_action( 'wp_validate_site_data', WP_Error $errors, array $data, WP_Site|null $old_site )

Fires when data should be validated for a site prior to inserting or updating in the database.


Description

Plugins should amend the $errors object via its WP_Error::add() method.


Top ↑

Parameters

$errors WP_Error
Error object to add validation errors to.
$data array
Associative array of complete site data. See wp_insert_site() for the included data.
More Arguments from wp_insert_site( ... $data ) Data for the new site that should be inserted.
  • domainstring
    Site domain. Default empty string.
  • pathstring
    Site path. Default '/'.
  • network_idint
    The site's network ID. Default is the current network ID.
  • registeredstring
    When the site was registered, in SQL datetime format. Default is the current time.
  • last_updatedstring
    When the site was last updated, in SQL datetime format. Default is the value of $registered.
  • publicint
    Whether the site is public. Default 1.
  • archivedint
    Whether the site is archived. Default 0.
  • matureint
    Whether the site is mature. Default 0.
  • spamint
    Whether the site is spam. Default 0.
  • deletedint
    Whether the site is deleted. Default 0.
  • lang_idint
    The site's language ID. Currently unused. Default 0.
  • user_idint
    User ID for the site administrator. Passed to the wp_initialize_site hook.
  • titlestring
    Site title. Default is 'Site %d' where %d is the site ID. Passed to the wp_initialize_site hook.
  • optionsarray
    Custom option $key => $value pairs to use. Default empty array. Passed to the wp_initialize_site hook.
  • metaarray
    Custom site metadata $key => $value pairs to use. Default empty array.
    Passed to the wp_initialize_site hook.
$old_site WP_Site|null
The old site object if the data belongs to a site being updated, or null if it is a new site being inserted.

Top ↑

Source

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

do_action( 'wp_validate_site_data', $errors, $data, $old_site );


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.