Variable: org-agenda-skip-function

org-agenda-skip-function is a variable defined in org-agenda.el.gz.

Value

nil

Documentation

Function to be called at each match during agenda construction.

If this function returns nil, the current match should not be skipped. Otherwise, the function must return a position from where the search should be continued.

This may also be a Lisp form that will be evaluated. Useful forms include org-agenda-skip-entry-if and org-agenda-skip-subtree-if. See the Info node (org) Special Agenda Views for more details and examples.

Never set this variable using setq or similar, because then it will apply to all future agenda commands. If you want a global skipping condition, use the option org-agenda-skip-function-global instead.

The correct way to use org-agenda-skip-function is to bind it with let to scope it dynamically into the agenda-constructing command. A good way to set it is through options in org-agenda-custom-commands.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-agenda.el.gz
(defvar org-agenda-skip-function nil
  "Function to be called at each match during agenda construction.
If this function returns nil, the current match should not be skipped.
Otherwise, the function must return a position from where the search
should be continued.

This may also be a Lisp form that will be evaluated.  Useful
forms include `org-agenda-skip-entry-if' and
`org-agenda-skip-subtree-if'.  See the Info node `(org) Special
Agenda Views' for more details and examples.

Never set this variable using `setq' or similar, because then it
will apply to all future agenda commands.  If you want a global
skipping condition, use the option `org-agenda-skip-function-global'
instead.

The correct way to use `org-agenda-skip-function' is to bind it with `let'
to scope it dynamically into the agenda-constructing command.
A good way to set it is through options in `org-agenda-custom-commands'.")