XWiki API Reference

XWiki APIs are the methods that the XWiki development team consider safe to use because backward compatibility is guaranteed. They can be called from Java or directly from your wiki pages using a scripting language.

The XWiki Scripting Reference Documentation is available at this link.

The latest scripting API documentation is available as JavaDoc:

You might also be interested in the Rendering Engine API:

The full Javadoc is available at this link. In case you are interested in older Javadocs of XWiki, they can be found in our Maven Release repository.

It is not recommended to use a class having internal in its package because it means that the class is not a public API and the XWiki developers can change it at any time, thus its stability is not guaranteed.

When you see code marked with the @Unstable it means it is a new public API that is still considered unstable and that can change at any time.


Related Pages

Search this space


Most popular tags

Failed to execute the [groovy] macro
  1. access rights
  2. activity stream
  3. annotation
  4. attachment
  5. comment
  6. Document Tree Macro
  7. export
  8. Extension Manager
  9. Flamingo skin
  10. global user
  11. Groovy event listener
  12. group
  13. nested page
  14. search
  15. skin
  16. syntax
  17. user
  18. user profile
  19. velocity macros
  20. wiki
  21. wysiwyg
  22. XWiki Applications
  23. xwikiattachment_archive table
  24. xwikiattachment table
  25. xwikiattrecyclebin table
  26. xwikiproperties table

[Display all tags from this space]