API Documentation
\

\StreamManagerApi

Summary

Methods
Properties
Constants
stream_exists()
insert_stream()
delete_stream()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

stream_exists()

stream_exists(string  $slug) : boolean

Check if a stream is in the database

Parameters

string $slug

Returns

boolean

insert_stream()

insert_stream(string  $slug, string  $title = NULL, array  $query_array = NULL) : integer

Insert a new stream, with the option to pass a wp_query array to filter the stream.

Returns false if the stream already exists.

Parameters

string $slug
string $title
array $query_array

wp_query object

Returns

integer —

$pid ID of new stream

delete_stream()

delete_stream(string  $slug, boolean  $force_delete = true) : integer

Delete a stream by slug

Parameters

string $slug
boolean $force_delete

bypass trash and force deletion

Returns

integer —

$deleted ID of deleted stream