class CurrentUser

Default argument plugin to extract the global $user

This plugin actually has no options so it odes not need to do a great deal.

Plugin annotation

@Plugin(
  id = "current_user",
  module = "user",
  title = @Translation("User ID from logged in user")
)

Hierarchy

Expanded class hierarchy of CurrentUser

File

drupal/core/modules/user/lib/Drupal/user/Plugin/views/argument_default/CurrentUser.php, line 25

Definition of Drupal\user\Plugin\views\argument_default\CurrentUser.

Namespace

class CurrentUser extends ArgumentDefaultPluginBase {
  function get_argument() {
    global $user;
    return $user->uid;
  }

}

Members

Name contains

Name does not contain

Type

Name	Modifiers	Type	Description	Overrides
ArgumentDefaultPluginBase::access	public	function	Determine if the administrator has the privileges to use this plugin	1
ArgumentDefaultPluginBase::buildOptionsForm	public	function	Provide the default form for setting options. Overrides PluginBase::buildOptionsForm	5
ArgumentDefaultPluginBase::check_access		function	If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input.
ArgumentDefaultPluginBase::defineOptions	protected	function	Retrieve the options when this is a new access control plugin Overrides PluginBase::defineOptions	6
ArgumentDefaultPluginBase::init	public	function	Initialize this plugin with the view and the argument it is linked to.	1
ArgumentDefaultPluginBase::submitOptionsForm	public	function	Provide the default form form for submitting options Overrides PluginBase::submitOptionsForm	1
ArgumentDefaultPluginBase::validateOptionsForm	public	function	Provide the default form form for validating options Overrides PluginBase::validateOptionsForm
CurrentUser::get_argument		function	Return the default argument. Overrides ArgumentDefaultPluginBase::get_argument
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$definition	public	property	Plugins's definition
PluginBase::$discovery	protected	property	The discovery object.
PluginBase::$displayHandler	public	property	The display object this plugin is for.
PluginBase::$options	public	property	Options for this plugin will be held here.
PluginBase::$plugin_id	protected	property	The plugin_id.
PluginBase::$usesOptions	protected	property	Denotes whether the plugin has an additional options form.	8
PluginBase::$view	public	property	The top object of a view.	1
PluginBase::additionalThemeFunctions	public	function	Provide a list of additional theme functions for the theme information page
PluginBase::destroy	public	function	Clears a plugin.	2
PluginBase::getAvailableGlobalTokens	public	function	Returns an array of available token replacements.
PluginBase::getDefinition	public	function	Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface::getDefinition
PluginBase::getPluginId	public	function	Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface::getPluginId
PluginBase::globalTokenForm	public	function	Adds elements for available core tokens to a form.
PluginBase::globalTokenReplace	public	function	Returns a string with any core tokens replaced.
PluginBase::pluginTitle	public	function	Return the human readable name of the display.
PluginBase::query	public	function	Add anything to the query that we might need to.	13
PluginBase::setOptionDefaults	protected	function
PluginBase::summaryTitle	public	function	Returns the summary of the settings in the display.	6
PluginBase::themeFunctions	public	function	Provide a full list of possible theme templates used by this style.	1
PluginBase::unpackOptions	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
PluginBase::usesOptions	public	function	Returns the usesOptions property.	8
PluginBase::validate	public	function	Validate that the plugin is correct and can be saved.	4
PluginBase::__construct	public	function	Constructs a Plugin object. Overrides PluginBase::__construct