Variable: org-agenda-bulk-custom-functions

org-agenda-bulk-custom-functions is a customizable variable defined in org-agenda.el.gz.

Value

nil

Documentation

Alist of characters and custom functions for bulk actions.

For example, this makes those two functions available:

  (setq org-agenda-bulk-custom-functions
        '((?R set-category)
          (?C bulk-cut)))

With selected entries in an agenda buffer, B R will call the custom function set-category on the selected entries. Note that functions in this alist don't need to be quoted.

You can also specify a function which collects arguments to be used for each call to your bulk custom function. The argument collecting function will be run once and should return a list of arguments to pass to the bulk function. For example:

  (setq org-agenda-bulk-custom-functions
        '((?R set-category get-category)))

Now, B R will call the custom get-category which would prompt the user once for a category. That category is then passed as an argument to set-category for each entry it's called against.

This variable was added, or its default value changed, in Org version
9.5.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-agenda.el.gz
(defcustom org-agenda-bulk-custom-functions nil
  "Alist of characters and custom functions for bulk actions.
For example, this makes those two functions available:

  (setq org-agenda-bulk-custom-functions
        \\='((?R set-category)
          (?C bulk-cut)))

With selected entries in an agenda buffer, `B R' will call
the custom function `set-category' on the selected entries.
Note that functions in this alist don't need to be quoted.

You can also specify a function which collects arguments to be
used for each call to your bulk custom function.  The argument
collecting function will be run once and should return a list of
arguments to pass to the bulk function.  For example:

  (setq org-agenda-bulk-custom-functions
        \\='((?R set-category get-category)))

Now, `B R' will call the custom `get-category' which would prompt
the user once for a category.  That category is then passed as an
argument to `set-category' for each entry it's called against."
  :type
  '(alist :key-type character
	  :value-type
          (group (function :tag "Bulk Custom Function")
		 (choice (function :tag "Bulk Custom Argument Function")
                         (const :tag "No Bulk Custom Argument Function" nil))))
  :package-version '(Org . "9.5")
  :group 'org-agenda)