$roles->save() method

Save a Role

This is the same as calling $page->save()
If the page is new, it will be inserted. If existing, it will be updated.
If you want to just save a particular field in a Page, use $page->save($fieldName) instead.

Hook note:
If you want to hook this method, please hook the saveReady, saved, or one of the Pages::save* methods instead, as hooking this method will not hook relevant pages saved directly through $pages->save().

Usage

$bool = $roles->save($page);

Arguments

Name	Type(s)	Description
`page`	Role, Page

Return value

bool

True on success, false on failure

Exceptions

Method can throw exceptions on error:

WireException

Hooking $roles->save(…)

You can add your own hook events that are executed either before or after the $roles->save(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $roles->save(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Roles::save', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $roles = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $page);
});

Hooking after

The 'after' hooks are called immediately after each $roles->save(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Roles::save', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $roles = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $page = $event->arguments(0);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$roles methods and properties

API reference based on ProcessWire core version 3.0.244