PHP Cross Reference of WordPress Subversion HEAD

[ Index ]     [ Classes ]     [ Functions ]     [ Variables ]     [ Constants ]

title

Body

[close]

/wp-includes/ -> script-loader.php (summary)

(no description)

File Size: 445 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

WP_Scripts:: (11 methods):
  WP_Scripts()
  default_scripts()
  print_scripts()
  print_scripts_l10n()
  all_deps()
  add()
  localize()
  remove()
  enqueue()
  dequeue()
  query()

_WP_Script:: (8 methods):
  _WP_Script()
  localize()
  wp_print_scripts()
  wp_register_script()
  wp_localize_script()
  wp_deregister_script()
  wp_enqueue_script()
  wp_prototype_before_jquery()


Class: WP_Scripts  - X-Ref

WP_Scripts()   X-Ref
No description

default_scripts()   X-Ref
No description

print_scripts( $handles = false )   X-Ref
Prints script tags

Prints the scripts passed to it or the print queue.  Also prints all necessary dependencies.

param: mixed handles (optional) Scripts to be printed.  (void) prints queue, (string) prints that script, (array of strings) prints those scripts.
return: array Scripts that have been printed

print_scripts_l10n( $handle )   X-Ref
No description

all_deps( $handles, $recursion = false )   X-Ref
Determines dependencies of scripts

Recursively builds array of scripts to print taking dependencies into account.  Does NOT catch infinite loops.

param: mixed handles Accepts (string) script name or (array of strings) script names
param: bool recursion Used internally when function calls itself

add( $handle, $src, $deps = array()   X-Ref
Adds script

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

param: string handle Script name
param: string src Script url
param: array deps (optional) Array of script names on which this script depends
param: string ver (optional) Script version (used for cache busting)
return: array Hierarchical array of dependencies

localize( $handle, $object_name, $l10n )   X-Ref
Localizes a script

Localizes only if script has already been added

param: string handle Script name
param: string object_name Name of JS object to hold l10n info
param: array l10n Array of JS var name => localized string
return: bool Successful localization

remove( $handles )   X-Ref
No description

enqueue( $handles )   X-Ref
No description

dequeue( $handles )   X-Ref
No description

query( $handle, $list = 'scripts' )   X-Ref
No description

Class: _WP_Script  - X-Ref

_WP_Script()   X-Ref
No description

localize( $object_name, $l10n )   X-Ref
No description

wp_print_scripts( $handles = false )   X-Ref
Prints script tags in document head

Called by admin-header.php and by wp_head hook. Since it is called by wp_head on every page load,
the function does not instantiate the WP_Scripts object unless script names are explicitly passed.
Does make use of already instantiated $wp_scripts if present.
Use provided wp_print_scripts hook to register/enqueue new scripts.


wp_register_script( $handle, $src, $deps = array()   X-Ref
No description

wp_localize_script( $handle, $object_name, $l10n )   X-Ref
Localizes a script

Localizes only if script has already been added


wp_deregister_script( $handle )   X-Ref
No description

wp_enqueue_script( $handle, $src = false, $deps = array()   X-Ref
Equeues script

Registers the script if src provided (does NOT overwrite) and enqueues.


wp_prototype_before_jquery( $js_array )   X-Ref
No description



Generated Thu Dec 6 06:47:08 2007 for RedAlt XRefs Cross-referenced by PHPXref 0.6 and RedAlt