API Documentation
\

\StreamManagerAdmin

Summary

Methods
Properties
Constants
is_active()
get_instance()
enqueue_admin_styles()
enqueue_admin_scripts()
add_meta_boxes()
meta_box_stream()
meta_box_add()
meta_box_zones()
meta_box_rules()
save_stream()
add_help_text()
stream_categories_helper()
ajax_heartbeat()
ajax_retrieve_posts()
ajax_search_posts()
ajax_respond()
$plugin
$default_query
No constants found
No protected methods found
$instance
N/A
__construct()
No private properties found
N/A

Properties

$plugin

$plugin : object

Instance of StreamManager.

Type

object

$default_query

$default_query :

Type

$instance

$instance : object

Instance of this class.

Type

object

Methods

is_active()

is_active()

get_instance()

get_instance() : object

Return an instance of this class.

Returns

object —

A single instance of this class.

enqueue_admin_styles()

enqueue_admin_styles() : null

Register and enqueue admin-specific style sheet.

Returns

null —

Return early if no settings page is registered.

enqueue_admin_scripts()

enqueue_admin_scripts() : null

Register and enqueue admin-specific JavaScript.

Returns

null —

Return early if no settings page is registered.

add_meta_boxes()

add_meta_boxes()

Add meta boxes to Stream edit page

meta_box_stream()

meta_box_stream(object  $post)

Render Stream metabox

Parameters

object $post

WordPress post object

meta_box_add()

meta_box_add(object  $post)

Render Post Add metabox

Parameters

object $post

WordPress post object

meta_box_zones()

meta_box_zones(object  $post)

Render Layout metabox

Parameters

object $post

WordPress post object

meta_box_rules()

meta_box_rules(object  $post)

Render Rules metabox

Parameters

object $post

WordPress post object

save_stream()

save_stream(integer  $stream_id,   $apply_security_checks = true)

Save the stream metadata

Parameters

integer $stream_id

Stream Post ID
$apply_security_checks

add_help_text()

add_help_text()

Add help text to stream edit page

stream_categories_helper()

stream_categories_helper(  $args,   $post_id)

Parameters

$args
$post_id

ajax_heartbeat()

ajax_heartbeat(array  $response, array  $data, string  $screen_id) : array

Respond to admin heartbeat with stream IDs

Parameters

array $response

default WordPress heartbeat response
array $data

data included with WordPress heartbeat request
string $screen_id

admin screen slug

Returns

array —

WordPress heartbeat response

ajax_retrieve_posts()

ajax_retrieve_posts(array  $request)

Retrieve rendered post stubs

Parameters

array $request

AJAX request (uses $_POST instead)

ajax_search_posts()

ajax_search_posts(array  $request)

Retrieve search results

Parameters

array $request

AJAX request (uses $_POST instead)

ajax_respond()

ajax_respond(string  $status = 'error', array  $data = array())

Send AJAX response

Parameters

string $status

AJAX status (error|success)
array $data

data with which to respond

__construct()

__construct()

Initialize the plugin