[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

/wp-includes/ -> ms-deprecated.php (summary)

Deprecated functions from WordPress MU and the multisite feature. You shouldn't use these functions and look for the alternatives instead. The functions will be removed in a later version.

File Size: 687 lines (20 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 wp-admin/includes/upgrade.php

Defines 21 functions

  get_dashboard_blog()
  generate_random_password()
  is_site_admin()
  graceful_fail()
  get_user_details()
  clear_global_post_cache()
  is_main_blog()
  validate_email()
  get_blog_list()
  get_most_active_blogs()
  wpmu_admin_do_redirect()
  wpmu_admin_redirect_add_updated_param()
  get_user_id_from_string()
  get_blogaddress_by_domain()
  create_empty_blog()
  get_admin_users_for_domain()
  wp_get_sites()
  is_user_option_local()
  insert_blog()
  install_blog()
  install_blog_defaults()

Functions
Functions that are not part of a class:

get_dashboard_blog()   X-Ref
Get the "dashboard blog", the blog where users without a blog edit their profile data.
Dashboard blog functionality was removed in WordPress 3.1, replaced by the user admin.

return: WP_Site Current site object.

generate_random_password( $len = 8 )   X-Ref
Generates a random password.

param: int $len Optional. The length of password to generate. Default 8.

is_site_admin( $user_login = '' )   X-Ref
Determine if user is a site admin.

Plugins should use is_multisite() instead of checking if this function exists
to determine if multisite is enabled.

This function must reside in a file included only if is_multisite() due to
legacy function_exists() checks to determine if multisite is enabled.

param: string $user_login Optional. Username for the user to check. Default empty.

graceful_fail( $message )   X-Ref
Deprecated functionality to gracefully fail.


get_user_details( $username )   X-Ref
Deprecated functionality to retrieve user information.

param: string $username Username.

clear_global_post_cache( $post_id )   X-Ref
Deprecated functionality to clear the global post cache.

param: int $post_id Post ID.

is_main_blog()   X-Ref
Deprecated functionality to determin if the current site is the main site.


validate_email( $email, $check_domain = true)   X-Ref
Deprecated functionality to validate an email address.

param: string $email        Email address to verify.
param: bool   $check_domain Deprecated.
return: string|bool Either false or the valid email address.

get_blog_list( $start = 0, $num = 10, $deprecated = '' )   X-Ref
Deprecated functionality to retrieve a list of all sites.

param: int    $start      Optional. Offset for retrieving the blog list. Default 0.
param: int    $num        Optional. Number of blogs to list. Default 10.
param: string $deprecated Unused.

get_most_active_blogs( $num = 10, $display = true )   X-Ref
Deprecated functionality to retrieve a list of the most active sites.

param: int  $num     Optional. Number of activate blogs to retrieve. Default 10.
param: bool $display Optional. Whether or not to display the most active blogs list. Default true.
return: array List of "most active" sites.

wpmu_admin_do_redirect( $url = '' )   X-Ref
Redirect a user based on $_GET or $_POST arguments.

The function looks for redirect arguments in the following order:
1) $_GET['ref']
2) $_POST['ref']
3) $_SERVER['HTTP_REFERER']
4) $_GET['redirect']
5) $_POST['redirect']
6) $url

param: string $url Optional. Redirect URL. Default empty.

wpmu_admin_redirect_add_updated_param( $url = '' )   X-Ref
Adds an 'updated=true' argument to a URL.

param: string $url Optional. Redirect URL. Default empty.
return: string

get_user_id_from_string( $string )   X-Ref
Get a numeric user ID from either an email address or a login.

A numeric string is considered to be an existing user ID
and is simply returned as such.

param: string $string Either an email address or a login.
return: int

get_blogaddress_by_domain( $domain, $path )   X-Ref
Get a full blog URL, given a domain and a path.

param: string $domain
param: string $path
return: string

create_empty_blog( $domain, $path, $weblog_title, $site_id = 1 )   X-Ref
Create an empty blog.

param: string $domain       The new blog's domain.
param: string $path         The new blog's path.
param: string $weblog_title The new blog's title.
param: int    $site_id      Optional. Defaults to 1.
return: string|int The ID of the newly created blog

get_admin_users_for_domain( $domain = '', $path = '' )   X-Ref
Get the admin for a domain/path combination.

param: string $domain Optional. Network domain.
param: string $path   Optional. Network path.
return: array|false The network admins.

wp_get_sites( $args = array()   X-Ref
Return an array of sites for a network or networks.

param: array $args {
return: array An empty array if the installation is considered "large" via wp_is_large_network(). Otherwise,

is_user_option_local( $key, $user_id = 0, $blog_id = 0 )   X-Ref
Check whether a usermeta key has to do with the current blog.

param: string $key
param: int    $user_id Optional. Defaults to current user.
param: int    $blog_id Optional. Defaults to current blog.
return: bool

insert_blog($domain, $path, $site_id)   X-Ref
Store basic site info in the blogs table.

This function creates a row in the wp_blogs table and returns
the new blog's ID. It is the first step in creating a new blog.

param: string $domain  The domain of the new site.
param: string $path    The path of the new site.
param: int    $site_id Unless you're running a multi-network install, be sure to set this value to 1.
return: int|false The ID of the new row

install_blog( $blog_id, $blog_title = '' )   X-Ref
Install an empty blog.

Creates the new blog tables and options. If calling this function
directly, be sure to use switch_to_blog() first, so that $wpdb
points to the new blog.

param: int    $blog_id    The value returned by wp_insert_site().
param: string $blog_title The title of the new site.

install_blog_defaults( $blog_id, $user_id )   X-Ref
Set blog defaults.

This function creates a row in the wp_blogs table.

param: int $blog_id Ignored in this function.
param: int $user_id



Generated: Thu Jul 18 08:20:01 2019 Cross-referenced by PHPXref 0.7