domain_exists() – Checks whether a site name is already taken.

You appear to be a bot. Output may be restricted

Description

Checks whether a site name is already taken.

The name is the site's subdomain or the site's subdirectory path depending on the network settings. Used during the new site registration process to ensure that each site name is unique.

Usage

$int|null = domain_exists( $domain, $path, $network_id );

Parameters

$domain
( string ) required – The domain to be checked.
$path
( string ) required – The path to be checked.
$network_id
( int ) optional default: 1 – Optional. Network ID. Relevant only on multi-network installations.

Returns

int|null The site ID if the site name exists, null otherwise.

Source

File name: wordpress/wp-includes/ms-functions.php
Lines:

1 to 28 of 28
function domain_exists( $domain, $path, $network_id = 1 ) {
  $path   = trailingslashit( $path );
  $args   = array(
    'network_id'             => $network_id,
    'domain'                 => $domain,
    'path'                   => $path,
    'fields'                 => 'ids',
    'number'                 => 1,
    'update_site_meta_cache' => false,
  );
  $result = get_sites( $args );
  $result = array_shift( $result );

  
/**
 * Filters whether a site name is taken.
 *
 * The name is the site's subdomain or the site's subdirectory
 * path depending on the network settings.
 *
 * @since 3.5.0
 *
 * @param int|null $result     The site ID if the site name exists, null otherwise.
 * @param string   $domain     Domain to be checked.
 * @param string   $path       Path to be checked.
 * @param int      $network_id Network ID. Relevant only on multi-network installations.
 */
  return apply_filters( 'domain_exists', $result, $domain, $path, $network_id );
}
 

 View on GitHub View on Trac