shortcodes/oik-blogs.php

<?php // (C) Copyright Bobbing Wide 2013


/**
 * List blogs in a WordPress MultiSite environment 
 * 
 * This reinstates part of the deprecated get_blog_list() function for use with oik-ms
 * Notes: 
 * - oik-ms should only be installed in a WPMS environment where you are happy for other sites and their content to be accessed
 * - There is no security in this code over and above the existing WordPress MS security
 * - DON'T use this function in a large WPMS installation as the list can be very large
 * 
 * Alternative function NOT used: 
 * $wp_list_table = _get_list_table( 'WP_MS_Sites_List_Table' );
 * 
 * @return mixed - array of arrays [ "blog_id" 
 */
/*  function bw_get_blog_list() – List blogs in a WordPress MultiSite environment */


/**
 * Display information about each blog in the array of blogs
 * 
 */
/*  function bw_display_blogs() – Display information about each blog in the array of blogs */


/**
 * Get all blog details - whether by ID or blog name
 * 
 * @param $blog - blog ID or blog name or array of fields
 * @return mixed - $bloginfo
 (
    [blog_id] => 1
    [site_id] => 1
    [domain] => qw
    [path] => /wpms/
    [registered] => 2012-01-08 15:28:21
    [last_updated] => 2013-09-10 13:14:08
    [public] => 1
    [archived] => 0
    [mature] => 0
    [spam] => 0
    [deleted] => 0
    [lang_id] => 0
    [blogname] => WordPress Multi Site
    [siteurl] => http://qw/wpms
    [post_count] => 6
)

 
 */
/*  function bw_get_bloginfo() – Get all blog details – whether by ID or blog name */


/**
 * Display a blog option or shortcode
 */
/*  function bw_display_blog_field() – Display a blog option or shortcode */


/**
 * Display information about a blog in a particular format
 *
 */
/*  function bw_display_blog() – Display information about a blog in a particular format */


/** 
 * Implement [bw_blogs] shortcode to list the blogs on the multisite
 * 
 * @param array $atts - expected to either contain "blogs" or uses the index 0 values
 * @param string $content - not expected
 * @param string $tag - the shortcode used
 * @return string - nothing is generated directly by this shortcode
 */
/*  function bw_blogs() – Implement [bw_blogs] shortcode to list the blogs on the multisite */


/**
 * Help hook for "bw_blogs" shortcode
 */
/*  function bw_blogs__help() – Help hook for "bw_blogs" shortcode */


/**
 * Syntax hook for "bw_blogs" shortcode
 */
/*  function bw_blogs__syntax() – Syntax hook for "bw_blogs" shortcode */


/**
 *
 */