WordPress Cross Reference

Functions that are not part of a class:

Update the last_updated field for the current blog.

Get a full blog URL, given a blog id.

param: int $blog_id Blog ID
return: string

get_blogaddress_by_name( $blogname ) X-Ref

Get a full blog URL, given a blog name.

param: string $blogname The (subdomain or directory) name
return: string

get_id_from_blogname( $slug ) X-Ref

Given a blog's (subdomain or directory) slug, retrieve its id.

param: string $slug
return: int A blog id

get_blog_details( $fields = null, $get_all = true ) X-Ref

Retrieve the details for a blog from the blogs table and blog options.

param: int|string|array $fields A blog ID, a blog slug, or an array of fields to query against. Optional. If not specified the current blog ID is used.
param: bool $get_all Whether to retrieve all details or only the details in the blogs table. Default is true.
return: object Blog details.

refresh_blog_details( $blog_id ) X-Ref

Clear the blog details cache.

param: int $blog_id Blog ID

update_blog_details( $blog_id, $details = array() X-Ref

Update the details for a blog. Updates the blogs table for a given blog id.

param: int $blog_id Blog ID
param: array $details Array of details keyed by blogs table field names.
return: bool True if update succeeds, false otherwise.

clean_blog_cache( $blog ) X-Ref

Clean the blog cache

param: stdClass $blog The blog details as returned from get_blog_details()

get_blog_option( $id, $option, $default = false ) X-Ref

Retrieve option value for a given blog id based on name of option.

If the option does not exist or does not have a value, then the return value
will be false. This is useful to check whether you need to install an option
and is commonly used during installation of plugin options and to test
whether upgrading is required.

If the option was serialized then it will be unserialized when it is returned.

param: int $id A blog ID. Can be null to refer to the current blog.
param: string $option Name of option to retrieve. Expected to not be SQL-escaped.
param: mixed $default Optional. Default value to return if the option does not exist.
return: mixed Value set for the option.

add_blog_option( $id, $option, $value ) X-Ref

Add a new option for a given blog id.

You do not need to serialize values. If the value needs to be serialized, then
it will be serialized before it is inserted into the database. Remember,
resources can not be serialized or added as an option.

You can create options without values and then update the values later.
Existing options will not be updated and checks are performed to ensure that you
aren't adding a protected WordPress option. Care should be taken to not name
options the same as the ones which are protected.

param: int $id A blog ID. Can be null to refer to the current blog.
param: string $option Name of option to add. Expected to not be SQL-escaped.
param: mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
return: bool False if option was not added and true if option was added.

delete_blog_option( $id, $option ) X-Ref

Removes option by name for a given blog id. Prevents removal of protected WordPress options.

param: int $id A blog ID. Can be null to refer to the current blog.
param: string $option Name of option to remove. Expected to not be SQL-escaped.
return: bool True, if option is successfully deleted. False on failure.

update_blog_option( $id, $option, $value, $deprecated = null ) X-Ref

Update an option for a particular blog.

param: int $id The blog id
param: string $option The option key
param: mixed $value The option value
return: bool True on success, false on failure.

switch_to_blog( $new_blog, $deprecated = null ) X-Ref

Switch the current blog.

This function is useful if you need to pull posts, or other information,
from other blogs. You can switch back afterwards using restore_current_blog().

Things that aren't switched:
- autoloaded options. See #14992
- plugins. See #14941

param: int $new_blog The id of the blog you want to switch to. Default: current blog
param: bool $deprecated Deprecated argument
return: bool True on success, false if the validation failed

restore_current_blog() X-Ref

Restore the current blog, after calling switch_to_blog()

return: bool True on success, false if we're already on the current blog

ms_is_switched() X-Ref

Determines if switch_to_blog() is in effect

return: bool True if switched, false otherwise.

is_archived( $id ) X-Ref

Check if a particular blog is archived.

param: int $id The blog id
return: string Whether the blog is archived or not

update_archived( $id, $archived ) X-Ref

Update the 'archived' status of a particular blog.

param: int $id The blog id
param: string $archived The new status
return: string $archived

update_blog_status( $blog_id, $pref, $value, $deprecated = null ) X-Ref

Update a blog details field.

param: int $blog_id BLog ID
param: string $pref A field name
param: string $value Value for $pref
return: string $value

get_blog_status( $id, $pref ) X-Ref

Get a blog details field.

param: int $id The blog id
param: string $pref A field name
return: bool $value

get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) X-Ref

Get a list of most recently updated blogs.

param: mixed $deprecated Not used
param: int $start The offset
param: int $quantity The maximum number of blogs to retrieve. Default is 40.
return: array The list of blogs

_update_blog_date_on_post_publish( $new_status, $old_status, $post ) X-Ref

Handler for updating the blog date when a post is published or an already published post is changed.

param: string $new_status The new post status
param: string $old_status The old post status
param: object $post Post object

_update_blog_date_on_post_delete( $post_id ) X-Ref

Handler for updating the blog date when a published post is deleted.

param: int $post_id Post ID

File Size:	894 lines (25 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

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

Defines 22 functions