Class WP_Dependencies

Description
Direct descendents
Class Description
 class WP_Scripts
 class WP_Styles
Variable Summary
 mixed $args
 mixed $done
 mixed $queue
 mixed $registered
 mixed $to_do
Method Summary
 WP_Dependencies __construct ()
 WP_Dependencies WP_Dependencies ()
 array add (string $handle, string $src, [array $deps = array()], [string $ver = false], [ $args = null])
 bool add_data (string $handle, string $data_name, array $data)
 void all_deps (mixed $handles, [bool $recursion = false])
 void dequeue ( $handles)
 void do_item ( $handle)
 array do_items ([mixed $handles = false])
 void enqueue ( $handles)
 void query ( $handle, [ $list = 'registered'])
 void remove ( $handles)
Variables
mixed $args = array() (line 8)
mixed $done = array() (line 7)
mixed $queue = array() (line 5)
mixed $registered = array() (line 4)
mixed $to_do = array() (line 6)
Methods
Constructor __construct (line 15)
WP_Dependencies __construct ()

Redefined in descendants as:
Constructor WP_Dependencies (line 10)
WP_Dependencies WP_Dependencies ()
add (line 103)

Adds item

Adds the item only if no item of that name already exists

  • return: Hierarchical array of dependencies
array add (string $handle, string $src, [array $deps = array()], [string $ver = false], [ $args = null])
  • string $handle: handle Script name
  • string $src: src Script url
  • array $deps: deps (optional) Array of script names on which this script depends
  • string $ver: ver (optional) Script version (used for cache busting)
  • $args
add_data (line 120)

Adds extra data

Adds data only if script has already been added

  • return: success
bool add_data (string $handle, string $data_name, array $data)
  • string $handle: handle Script name
  • string $data_name: data_name Name of object in which to store extra data
  • array $data: data Array of extra data
all_deps (line 56)

Determines dependencies

Recursively builds array of items to process taking dependencies into account. Does NOT catch infinite loops.

void all_deps (mixed $handles, [bool $recursion = false])
  • mixed $handles: handles Accepts (string) dep name or (array of strings) dep names
  • bool $recursion: recursion Used internally when function calls itself

Redefined in descendants as:
dequeue (line 142)
void dequeue ( $handles)
  • $handles
do_item (line 43)
void do_item ( $handle)
  • $handle

Redefined in descendants as:
do_items (line 25)

Do the dependencies

Process the items passed to it or the queue. Processes all dependencies.

  • return: Items that have been processed
array do_items ([mixed $handles = false])
  • mixed $handles: handles (optional) items to be processed. (void) processes queue, (string) process that item, (array of strings) process those items
enqueue (line 131)
void enqueue ( $handles)
  • $handles
query (line 147)
void query ( $handle, [ $list = 'registered'])
  • $handle
  • $list
remove (line 126)
void remove ( $handles)
  • $handles

Documentation generated on Fri, 12 Sep 2008 21:09:01 -0400 by phpDocumentor 1.4.1