Well-documented API examples for a broad range of Backdrop core functionality.

Developers can learn how to use a particular API quickly by experimenting with the examples, and adapt them for their own use.

Based on the Examples for Developers Project at http://DOCUMENTATION_PENDING/project/examples


modules/examples/examples.module, line 14
This file serves as a stub file for the many Examples modules in the Examples for Developers Project which you can download and experiment with.


Namesort descending Location Description
Example: Action modules/examples/action_example/action_example.module Creating actions in Backdrop
Example: AJAX modules/examples/ajax_example/ajax_example.module These examples show basic AJAX concepts.
Example: AJAX Graceful Degradation modules/examples/ajax_example/ajax_example_graceful_degradation.inc These examples show AJAX with graceful degradation when Javascript is not available.
Example: Batch API modules/examples/batch_example/batch_example.module Outlines how a module can use the Batch API.
Example: Block modules/examples/block_example/block_example.module Demonstrates code creation of blocks.
Example: Cache API modules/examples/cache_example/cache_example.module Outlines how a module can use the Cache API.
Example: Contextual Links modules/examples/contextual_links_example/contextual_links_example.module Example of implementing contextual links.
Example: Cron modules/examples/cron_example/cron_example.module Example using Cron API, including hook_cron() and hook_cron_queue_info().
Example: Database (DBTNG) modules/examples/dbtng_example/dbtng_example.module Database examples, including DBTNG.
Example: Email modules/examples/email_example/email_example.module Example of how to use Backdrop's mail API.
Example: Entity modules/examples/entity_example/entity_example.module Example creating a core Entity API entity.
Example: Field Permissions modules/examples/field_permission_example/field_permission_example.module Example using permissions on a Field API field.
Example: Field Types API modules/examples/field_example/field_example.module Examples using Field Types API.
Example: Files modules/examples/file_example/file_example.module Examples demonstrating the backdrop File API (and Stream Wrappers).
Example: Filter modules/examples/filter_example/filter_example.module Demonstrates the creation of filters.
Example: Form API modules/examples/form_example/form_example.module Examples demonstrating the Backdrop Form API.
Example: Image modules/examples/image_example/image_example.module Demonstrates the basic use of image API.
Example: JavaScript modules/examples/js_example/js_example.module Examples using Backdrop's built-in JavaScript.
Example: Menu modules/examples/menu_example/menu_example.module Demonstrates uses of the Menu APIs in Backdrop.
Example: Node modules/examples/node_example/node_example.module Example defining a node type in code.
Example: Node Access modules/examples/node_access_example/node_access_example.module Demonstrates node access.
Example: NodeAPI modules/examples/nodeapi_example/nodeapi_example.module Example using NodeAPI.
Example: Page modules/examples/page_example/page_example.module This example demonstrates how a module can display a page at a given URL.
Example: Pager modules/examples/pager_example/pager_example.module Example of a results pager.
Example: Queue modules/examples/queue_example/queue_example.module Demonstrating the Queue API
Example: Render modules/examples/render_example/render_example.module Demonstrate how render arrays are arranged and how they can be altered. This alters blocks and the page to show the actual render array that is being used to create each item.
Example: Simpletest modules/examples/simpletest_example/simpletest_example.module An example of simpletest tests to accompany the tutorial at https://api.backdropcms.org/node/41659.
Example: Tabledrag modules/examples/tabledrag_example/tabledrag_example.module Example of draggable table rows.
Example: Tablesort modules/examples/tablesort_example/tablesort_example.module Example of a sortable table display.
Example: Theming modules/examples/theming_example/theming_example.module Example of Backdrop theming.
Example: Token API modules/examples/token_example/token_example.module Examples using the Token API.
Example: Vertical Tabs modules/examples/vertical_tabs_example/vertical_tabs_example.module Demonstrates the vertical tabs functionality provided by Backdrop.