WP_ADDROLE

Class GEN_ADDROLE

Contents

  • Methods

  • Source Source

    File: src/integrations/wp/actions/wp-addrole.php

    class WP_ADDROLE {
    
    	/**
    	 * Integration code
    	 * @var string
    	 */
    	public static $integration = 'WP';
    
    	private $action_code;
    	private $action_meta;
    
    	/**
    	 * Set up Automator action constructor.
    	 */
    	public function __construct() {
    		$this->action_code = 'ADDROLE';
    		$this->action_meta = 'WPROLE';
    		$this->define_action();
    	}
    
    	/**
    	 * Define and register the action by pushing it into the Automator object
    	 */
    	public function define_action() {
    
    
    
    		$action = array(
    			'author'             => Automator()->get_author_name( $this->action_code ),
    			'support_link'       => Automator()->get_author_support_link( $this->action_code, 'integration/wordpress-core/' ),
    			'integration'        => self::$integration,
    			'code'               => $this->action_code,
    			/* translators: Action - WordPress */
    			'sentence'           => sprintf( esc_attr__( "Add {{a new role:%1\$s}} to the user's roles", 'uncanny-automator' ), $this->action_meta ),
    			/* translators: Action - WordPress */
    			'select_option_name' => esc_attr__( "Add {{a new role}} to the user's roles", 'uncanny-automator' ),
    			'priority'           => 11,
    			'accepted_args'      => 3,
    			'execution_function' => array( $this, 'add_role' ),
    			'options'            => [
    				Automator()->helpers->recipe->wp->options->wp_user_roles(),
    			],
    		);
    
    		Automator()->register->action( $action );
    	}
    
    	/**
    	 * Validation function when the trigger action is hit
    	 *
    	 * @param $user_id
    	 * @param $action_data
    	 * @param $recipe_id
    	 */
    	public function add_role( $user_id, $action_data, $recipe_id ) {
    
    
    
    		$role = $action_data['meta'][ $this->action_meta ];
    
    		$user_obj = new WP_User( (int) $user_id );
    		if ( $user_obj instanceof WP_User ) {
    			$user_obj->add_role( $role );
    			Automator()->complete->user->action( $user_id, $action_data, $recipe_id );
    		}
    	}
    }
    

    Methods Methods

    • __construct — Set up Automator action constructor.
    • add_role — Validation function when the trigger action is hit
    • define_action — Define and register the action by pushing it into the Automator object