[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

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

Site/blog functions that work with the blogs table and related data.

File Size: 969 lines (26 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 2 files
 wp-includes/ms-site.php
 wp-includes/ms-network.php

Defines 26 functions

  wpmu_update_blogs_date()
  get_blogaddress_by_id()
  get_blogaddress_by_name()
  get_id_from_blogname()
  get_blog_details()
  refresh_blog_details()
  update_blog_details()
  clean_site_details_cache()
  get_blog_option()
  add_blog_option()
  delete_blog_option()
  update_blog_option()
  switch_to_blog()
  restore_current_blog()
  wp_switch_roles_and_user()
  ms_is_switched()
  is_archived()
  update_archived()
  update_blog_status()
  get_blog_status()
  get_last_updated()
  _update_blog_date_on_post_publish()
  _update_blog_date_on_post_delete()
  _update_posts_count_on_delete()
  _update_posts_count_on_transition_post_status()
  wp_count_sites()

Functions
Functions that are not part of a class:

wpmu_update_blogs_date()   X-Ref
Updates the last_updated field for the current site.


get_blogaddress_by_id( $blog_id )   X-Ref
Gets a full site URL, given a site ID.

param: int $blog_id Site ID.
return: string Full site URL if found. Empty string if not.

get_blogaddress_by_name( $blogname )   X-Ref
Gets a full site URL, given a site name.

param: string $blogname Name of the subdomain or directory.
return: string

get_id_from_blogname( $slug )   X-Ref
Retrieves a site's ID given its (subdomain or directory) slug.

param: string $slug A site's slug.
return: int|null The site ID, or null if no site is found for the given slug.

get_blog_details( $fields = null, $get_all = true )   X-Ref
Retrieves the details for a blog from the blogs table and blog options.

param: int|string|array $fields  Optional. A blog ID, a blog slug, 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.
return: WP_Site|false Blog details on success. False on failure.

refresh_blog_details( $blog_id = 0 )   X-Ref
Clears the blog details cache.

param: int $blog_id Optional. Blog ID. Defaults to current blog.

update_blog_details( $blog_id, $details = array()   X-Ref
Updates the details for a blog and 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_site_details_cache( $site_id = 0 )   X-Ref
Cleans the site details cache for a site.

param: int $site_id Optional. Site ID. Default is the current site ID.

get_blog_option( $id, $option, $default_value = false )   X-Ref
Retrieves 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_value 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
Adds 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  Option value, can be anything. Expected to not be SQL-escaped.
return: bool True if the option was added, false otherwise.

delete_blog_option( $id, $option )   X-Ref
Removes an 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 the option was deleted, false otherwise.

update_blog_option( $id, $option, $value, $deprecated = null )   X-Ref
Updates an option for a particular blog.

param: int    $id         The blog ID.
param: string $option     The option key.
param: mixed  $value      The option value.
param: mixed  $deprecated Not used.
return: bool True if the value was updated, false otherwise.

switch_to_blog( $new_blog_id, $deprecated = null )   X-Ref
Switches 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().

PHP code loaded with the originally requested site, such as code from a plugin or theme, does not switch. See #14941.

param: int  $new_blog_id The ID of the blog to switch to. Default: current blog.
param: bool $deprecated  Not used.
return: true Always returns true.

restore_current_blog()   X-Ref
Restores the current blog, after calling switch_to_blog().

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

wp_switch_roles_and_user( $new_site_id, $old_site_id )   X-Ref
Switches the initialized roles and current user capabilities to another site.

param: int $new_site_id New site ID.
param: int $old_site_id Old site ID.

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
Checks if a particular blog is archived.

param: int $id Blog ID.
return: string Whether the blog is archived or not.

update_archived( $id, $archived )   X-Ref
Updates the 'archived' status of a particular blog.

param: int    $id       Blog ID.
param: string $archived The new status.
return: string $archived

update_blog_status( $blog_id, $pref, $value, $deprecated = null )   X-Ref
Updates a blog details field.

param: int    $blog_id    Blog ID.
param: string $pref       Field name.
param: string $value      Field value.
param: null   $deprecated Not used.
return: string|false $value

get_blog_status( $id, $pref )   X-Ref
Gets a blog details field.

param: int    $id   Blog ID.
param: string $pref Field name.
return: bool|string|null $value

get_last_updated( $deprecated = '', $start = 0, $quantity = 40 )   X-Ref
Gets a list of most recently updated blogs.

param: mixed $deprecated Not used.
param: int   $start      Optional. Number of blogs to offset the query. Used to build LIMIT clause.
param: int   $quantity   Optional. The maximum number of blogs to retrieve. Default 40.
return: array The list of blogs.

_update_blog_date_on_post_publish( $new_status, $old_status, $post )   X-Ref
Handler for updating the site's last updated 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: WP_Post $post       Post object.

_update_blog_date_on_post_delete( $post_id )   X-Ref
Handler for updating the current site's last updated date when a published
post is deleted.

param: int $post_id Post ID

_update_posts_count_on_delete( $post_id, $post )   X-Ref
Handler for updating the current site's posts count when a post is deleted.

param: int     $post_id Post ID.
param: WP_Post $post    Post object.

_update_posts_count_on_transition_post_status( $new_status, $old_status, $post = null )   X-Ref
Handler for updating the current site's posts count when a post status changes.

param: string  $new_status The status the post is changing to.
param: string  $old_status The status the post is changing from.
param: WP_Post $post       Post object

wp_count_sites( $network_id = null )   X-Ref
Counts number of sites grouped by site status.

param: int $network_id Optional. The network to get counts for. Default is the current network ID.
return: int[] {



Generated : Tue Mar 19 08:20:01 2024 Cross-referenced by PHPXref