[ Index ]

PHP Cross Reference of WordPress 3.0 beta 1

[ Index ]     [ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

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

(no description)

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

Defines 20 functions

  wpmu_update_blogs_date()
  get_blogaddress_by_id()
  get_blogaddress_by_name()
  get_blogaddress_by_domain()
  get_id_from_blogname()
  get_blog_details()
  refresh_blog_details()
  update_blog_details()
  get_blog_option()
  add_blog_option()
  delete_blog_option()
  update_blog_option()
  switch_to_blog()
  restore_current_blog()
  is_archived()
  update_archived()
  update_blog_status()
  get_blog_status()
  get_last_updated()
  get_blog_list()

Functions
Functions that are not part of a class:

wpmu_update_blogs_date()   X-Ref
Site/blog functions that work with the blogs table and related data.


get_blogaddress_by_id( $blog_id )   X-Ref
No description

get_blogaddress_by_name( $blogname )   X-Ref
No description

get_blogaddress_by_domain( $domain, $path )   X-Ref
No description

get_id_from_blogname( $name )   X-Ref
No description

get_blog_details( $fields, $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 name, or an array of fields to query against.
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.

get_blog_option( $blog_id, $setting, $default = false )   X-Ref
Retrieve option value based on setting name and blog_id.

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.

There is a filter called 'blog_option_$option' with the $option being
replaced with the option name. The filter takes two parameters. $value and
$blog_id. It returns $value.
The 'option_$option' filter in get_option() is not called.

param: int $blog_id is the id of the blog.
param: string $setting Name of option to retrieve. Should already be SQL-escaped
param: string $default (optional) Default value returned if option not found.
return: mixed Value set for the option.

add_blog_option( $id, $key, $value )   X-Ref
No description

delete_blog_option( $id, $key )   X-Ref
No description

update_blog_option( $id, $key, $value, $refresh = true )   X-Ref
No description

switch_to_blog( $new_blog, $validate = false )   X-Ref
No description

restore_current_blog()   X-Ref
No description

is_archived( $id )   X-Ref
No description

update_archived( $id, $archived )   X-Ref
No description

update_blog_status( $blog_id, $pref, $value, $refresh = true )   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
param: bool $refresh Whether to refresh the blog details cache. Default is true.

get_blog_status( $id, $pref )   X-Ref
No description

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

get_blog_list( $start = 0, $num = 10, $deprecated = '' )   X-Ref
No description



Generated: Mon Apr 5 14:26:09 2010 Cross-referenced by PHPXref 0.7