book.module

Allows users to create and organize related content in an outline.

File

modules/book/book.module

Functions

Name Description
book_admin_paths Implements hook_admin_paths().
book_block_configure Implements hook_block_configure().
book_block_info Implements hook_block_info().
book_block_save Implements hook_block_save().
book_block_view Implements hook_block_view().
book_children Formats the menu links for the child pages of the current page.
book_entity_info_alter Implements hook_entity_info_alter().
book_export_traverse Traverses the book tree to build printable or exportable output.
book_form_node_delete_confirm_alter Implements hook_form_FORM_ID_alter() for node_delete_confirm().
book_form_node_form_alter Implements hook_form_BASE_FORM_ID_alter() for node_form().
book_form_update Renders a new parent page select element when the book selection changes.
book_get_books Returns an array of all books.
book_get_flat_menu Gets the book menu tree for a page and returns it as a linear array.
book_help Implements hook_help().
book_link_load Gets a book menu link by its menu link ID.
book_menu Implements hook_menu().
book_menu_name Generates the corresponding menu name from a book ID.
book_menu_subtree_data Gets the data representing a subtree of the book hierarchy.
book_next Fetches the menu link for the next page of the book.
book_node_delete Implements hook_node_delete().
book_node_export Generates printer-friendly HTML for a node.
book_node_insert Implements hook_node_insert().
book_node_load Implements hook_node_load().
book_node_prepare Implements hook_node_prepare().
book_node_presave Implements hook_node_presave().
book_node_type_update Implements hook_node_type_update().
book_node_update Implements hook_node_update().
book_node_view Implements hook_node_view().
book_node_view_link Adds relevant book links to the node's links.
book_page_alter Implements hook_page_alter().
book_permission Implements hook_permission().
book_pick_book_nojs_submit Form submission handler for node_form().
book_prev Fetches the menu link for the previous page of the book.
book_theme Implements hook_theme().
book_toc Returns an array of book pages in table of contents order.
book_type_is_allowed Determine if a given node type is in the list of types allowed for books.
book_update_bid Updates the book ID of a page and its children when it moves to a new book.
template_preprocess_book_all_books_block Processes variables for book-all-books-block.tpl.php.
template_preprocess_book_export_html Processes variables for book-export-html.tpl.php.
template_preprocess_book_navigation Processes variables for book-navigation.tpl.php.
template_preprocess_book_node_export_html Processes variables for book-node-export-html.tpl.php.
theme_book_title_link Returns HTML for a link to a book title when used as a block title.
_book_add_form_elements Builds the common elements of the book form for the node and outline forms.
_book_flatten_menu Recursively converts a tree of menu links to a flat array.
_book_link_defaults Returns an array with default values for a book page's menu link.
_book_node_is_removable Determines if a node can be removed from the book.
_book_outline_access Access callback: Determines if the outline tab is accessible.
_book_outline_remove_access Access callback: Determines if the user can remove nodes from the outline.
_book_parent_depth_limit Finds the depth limit for items in the parent select.
_book_parent_select Builds the parent selection form element for the node form or outline tab.
_book_toc_recurse Recursively processes and formats menu items for book_toc().
_book_update_outline Handles additions and updates to the book outline.

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/modules!book!book.module/7.x