FluentAuth

https://github.com/wpmanageninja/fluent-security
Admin
A lightweight WordPress security plugin providing login/signup security, two-factor authentication,...
Tokens:7,653
Snippets:149
Trust Score:9.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### GitHub Actions Example for Running Tests

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

This YAML configuration demonstrates how to set up a GitHub Actions workflow to run PHPUnit tests, including dependency installation and coverage reporting.

```yaml
name: Tests

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    
    steps:
    - uses: actions/checkout@v3
    
    - name: Setup PHP
      uses: shivammathur/setup-php@v2
      with:
        php-version: '7.4'
        extensions: mbstring, xml, curl
        coverage: xdebug
    
    - name: Install dependencies
      run: composer install --dev
    
    - name: Run tests
      run: ./tests/vendor/bin/phpunit --coverage-clover coverage.xml
    
    - name: Upload coverage to Codecov
      uses: codecov/codecov-action@v3
```

--------------------------------

### Permission Check Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Example of checking user capabilities in PHP.

```php
if (!current_user_can('manage_options')) {
    return new \WP_Error('permission_denied', 'Access denied');
}
```

--------------------------------

### PHP Method Naming Convention Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Examples of method naming conventions in PHP.

```php
public function getAuthSettings()
public function validateSettings()
```

--------------------------------

### SCSS/Sass Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Example of SCSS/Sass code using BEM naming convention.

```scss
.fframe_app {
    &__body {
        // styles
    }
    
    .fframe_menu_item {
        // styles
        
        &--active {
            // active state
        }
    }
}
```

--------------------------------

### PHP Class Naming Convention Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Examples of class naming conventions in PHP.

```php
class SettingsController
class AuthHelper
```

--------------------------------

### PHP Constant Naming Convention Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Example of constant naming convention in PHP.

```php
define('FLUENT_AUTH_VERSION', '2.1.1');
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Installs PHP, Composer, and project dependencies for the testing suite.

```bash
# Install PHP and Composer if not already installed
# On Ubuntu/Debian:
sudo apt-get install php php-xml php-mbstring composer

# Install project dependencies
composer install --dev
```

--------------------------------

### Install WordPress Test Environment

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Installs the WordPress test suite for integration testing.

```bash
# Install WordPress test suite
bash bin/install-wp-tests.sh wordpress_test root root localhost latest
```

--------------------------------

### Vue Component Naming Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Example of Vue component file naming and template usage.

```vue
<!-- Dashboard.vue -->
<template>
  <div class="dashboard-component">
    <!-- content -->
  </div>
</template>
```

--------------------------------

### Output Escaping Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Examples of escaping output in PHP.

```php
echo esc_html($output);
echo esc_url($url);
echo wp_kses($html, $allowed_html);
```

--------------------------------

### PHP Variable Naming Convention Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Examples of variable naming conventions in PHP.

```php
$authSettings
$userRoles
```

--------------------------------

### Running Tests with PHPUnit Watcher

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Instructions for installing and using PHPUnit Watcher to automatically run tests when file changes are detected during local development.

```bash
# Install file watcher (optional)
composer require --dev spatie/phpunit-watcher

# Run tests on file changes
./tests/vendor/bin/phpunit-watcher watch
```

--------------------------------

### Input Sanitization Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Examples of using WordPress sanitization functions.

```php
$sanitized = sanitize_text_field($input);
$url = sanitize_url($input);
$html = wp_kses_post($input);
```

--------------------------------

### Nonce Verification Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Example of how to perform nonce verification for form submissions and AJAX requests.

```php
check_admin_referer('fluent_auth_action');
```

--------------------------------

### Run Specific Test Files

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Examples of running specific test files or directories using PHPUnit.

```bash
# Run Arr helper tests
./tests/vendor/bin/phpunit tests/Unit/ArrTest.php

# Run Helper tests
./tests/vendor/bin/phpunit tests/Unit/HelperTest.php

# Run AuthService tests
./tests/vendor/bin/phpunit tests/Unit/AuthServiceTest.php

# Run SettingsController tests
./tests/vendor/bin/phpunit tests/Unit/SettingsControllerTest.php

# Run Activator tests
./tests/vendor/bin/phpunit tests/Unit/ActivatorTest.php

# Run integration tests
./tests/vendor/bin/phpunit tests/Integration/
```

--------------------------------

### JavaScript Async Function Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Example of an asynchronous function in JavaScript using async/await and try/catch.

```javascript
async function fetchSettings() {
    try {
        const response = await this.$post('settings/get');
        return response.data;
    } catch (error) {
        this.$handleError(error);
    }
}
```

--------------------------------

### Internationalization Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Examples of using WordPress i18n functions for translatable text.

```php
__('Settings has been updated', 'fluent-security')
```

```php
_e('Error message', 'fluent-security')
```

--------------------------------

### JavaScript/Vue Build Commands

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Commands for installing dependencies and building assets using Laravel Mix.

```bash
# Install dependencies
npm install

# Build assets using Laravel Mix
npm run dev        # Development build
npm run prod       # Production build
npm run watch      # Watch for changes
```

--------------------------------

### Error Handling Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Example of error handling using WP_Error objects in PHP.

```php
if (is_wp_error($settings)) {
    return $settings;
}

return new \WP_Error('validation_error', 'Form Validation failed', $errors);
```

--------------------------------

### Database Operations Example

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Example of using the flsDb fluent query builder for database operations.

```php
flsDb()->table('fls_auth_logs')
    ->where('created_at', '<', $dateTime)
    ->delete();
```

--------------------------------

### Development Commands

Source: https://github.com/wpmanageninja/fluent-security/blob/master/README.md

Commands for installing dependencies, watching for changes, and building the project during development.

```bash
npm install
npx mix
npx mix watch
npx mix --production
```

--------------------------------

### Running PHPStan

Source: https://github.com/wpmanageninja/fluent-security/blob/master/README.md

Commands to install Composer dependencies and run PHPStan for static analysis.

```bash
composer install
composer phpstan
```

--------------------------------

### Run Tests and Stop on First Failure

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Runs tests and stops execution immediately upon encountering the first failure.

```bash
./tests/vendor/bin/phpunit --stop-on-failure
```

--------------------------------

### Run Tests with Verbose Output

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Runs tests with verbose output enabled.

```bash
./tests/vendor/bin/phpunit --verbose
```

--------------------------------

### Run All Tests (PHPUnit Directly)

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Executes all tests directly using the PHPUnit executable.

```bash
./tests/vendor/bin/phpunit
```

--------------------------------

### Run Tests with HTML Coverage Report

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Generates an HTML coverage report for the tests.

```bash
./tests/vendor/bin/phpunit --coverage-html coverage-report
```

--------------------------------

### Make Test Runner Executable

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Makes the test runner script executable.

```bash
chmod +x run-tests.php
```

--------------------------------

### Placeholder npm Test Script

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

The current placeholder test script in package.json.

```bash
npm test          # Returns "Error: no test specified" - needs to be implemented
```

--------------------------------

### Run All Tests (Custom Runner)

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Executes all tests using the custom test runner script.

```bash
php run-tests.php
```

--------------------------------

### PHPStan Static Analysis

Source: https://github.com/wpmanageninja/fluent-security/blob/master/AGENTS.md

Command to run PHPStan for static analysis.

```bash
# Run PHPStan static analysis
composer phpstan

# The command runs: phpstan analyse --memory-limit=1G --error-format=table > phpstan-errors.md
```

--------------------------------

### Commands

Source: https://github.com/wpmanageninja/fluent-security/blob/master/CLAUDE.md

Various commands for running tests, static analysis, frontend builds, and release builds.

```bash
# PHP tests
composer test                          # Run PHPUnit suite
./tests/vendor/bin/phpunit tests/Unit/HelperTest.php  # Single test file
./tests/vendor/bin/phpunit --filter "testMethodName"   # Single test method
composer test-coverage                 # HTML coverage report

# Static analysis
composer phpstan                       # PHPStan level 5 (outputs to phpstan-errors.md)

# Frontend build (Laravel Mix — no npm scripts defined, use npx directly)
npx mix                                # Development build
npx mix --production                   # Production build
npx mix watch                          # Watch mode

# Release build
sh build.sh --loco --node-build        # Full build for WP.org distribution
```

--------------------------------

### Run Tests with XML Coverage Report

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Generates an XML coverage report (Clover format) for CI/CD pipelines.

```bash
./tests/vendor/bin/phpunit --coverage-clover coverage.xml
```

--------------------------------

### Run Tests with Filter

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

Runs tests that match a specific filter string.

```bash
./tests/vendor/bin/phpunit --filter "testGetAuthSettings"
```

--------------------------------

### Google Client ID and Secret Key Configuration

Source: https://github.com/wpmanageninja/fluent-security/blob/master/_docs/social-connections/google-auth-connection.md

This code snippet shows how to define the Google Client ID and Client Secret in the wp-config.php file for FluentAuth.

```php
define('FLUENT_AUTH_GOOGLE_CLIENT_ID', '******');
define('FLUENT_AUTH_GOOGLE_CLIENT_SECRET', '******');
```

--------------------------------

### Only Signup Form

Source: https://github.com/wpmanageninja/fluent-security/blob/master/_docs/shortcodes.md

This shortcode renders only the signup form.

```html
[fluent_auth_signup]
```

--------------------------------

### Build for WP Org

Source: https://github.com/wpmanageninja/fluent-security/blob/master/README.md

Command to build the project specifically for the WordPress.org repository, including Loco translation support and Node.js build.

```bash
sh build.sh --loco --node-build
```

--------------------------------

### Only Magic Login Form

Source: https://github.com/wpmanageninja/fluent-security/blob/master/_docs/shortcodes.md

This shortcode renders only the magic login form, with an optional internal heading.

```html
[fluent_auth_magic_login]<h3>Your internal Heading</h3>[/fluent_auth_magic_login]
```

--------------------------------

### Only Login Form

Source: https://github.com/wpmanageninja/fluent-security/blob/master/_docs/shortcodes.md

This shortcode renders only the login form.

```html
[fluent_auth_login]
```

--------------------------------

### Add Facebook Credentials to wp-config.php

Source: https://github.com/wpmanageninja/fluent-security/blob/master/_docs/social-connections/facebook-auth-connection.md

This code snippet shows how to define the Facebook App ID and App Secret as constants in the wp-config.php file for integration with FluentAuth.

```php
define('FLUENT_AUTH_FACEBOOK_CLIENT_ID', '******');
define('FLUENT_AUTH_FACEBOOK_CLIENT_SECRET', '******');
```

--------------------------------

### Combined Shortcode

Source: https://github.com/wpmanageninja/fluent-security/blob/master/_docs/shortcodes.md

This shortcode provides a full authentication flow including login form, signup form, and password reset.

```html
[fluent_auth]
```

--------------------------------

### Only Password Reset Form

Source: https://github.com/wpmanageninja/fluent-security/blob/master/_docs/shortcodes.md

This shortcode renders only the password reset form.

```html
[fluent_auth_reset_password]
```

--------------------------------

### Enabling Debug Mode in Tests

Source: https://github.com/wpmanageninja/fluent-security/blob/master/TESTING.md

A PHP code snippet to enable debug mode within a test, which prints the name of the currently running test.

```php
// At the beginning of your test method
$reflection = new ReflectionClass($this->getName());
echo "Running test: " . $this->getName() . "\n";
```
Tokens:
Raw