Get WordPress

Plugin Directory

Changeset 2801543

Timestamp:
10/20/2022 12:53:54 AM (22 months ago)
Author:
sean212
Message:

Updating readme/assets from GitHub

Location:
rest-api-guard
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • rest-api-guard/tags/1.0.0/readme.txt

    r2801542 r2801543  
    1818## Usage
    1919
    20 The WordPress REST API is generally very public and can share a good deal of
    21 information with the internet anonymously. This plugin aims to make it easier to
    22 restrict access to the REST API for your WordPress site.
     20The WordPress REST API is generally very public and can share a good deal of information with the internet anonymously. This plugin aims to make it easier to restrict access to the REST API for your WordPress site.
     21
     22Out of the box the plugin can:
     23
     24- Disable anonymous access to the REST API.
     25- Restrict and control anonymous access to the REST API by namespace, path, etc.
    2326
    2427### Settings Page
    2528
    26 The plugin can be configured via the Settings page (`Settings -> REST API
    27 Guard`) or via the relevant filter.
     29The plugin can be configured via the Settings page (`Settings -> REST API Guard`) or via the relevant filter.
    2830
    2931![Screenshot of plugin settings screen](https://user-images.githubusercontent.com/346399/194411352-aa05e939-3fd1-4e37-a3d5-276c1c5c288f.png)
    … …  
    3133### Preventing Access to User Information (`wp/v2/users`)
    3234
    33 By default, the plugin will restrict anonymous access to the users endpoint.
    34 This can be prevented in the plugin's settings or via code:
     35By default, the plugin will restrict anonymous access to the users endpoint. This can be prevented in the plugin's settings or via code:
    3536
    3637    add_filter( 'rest_api_guard_allow_user_access', fn () => true );
    … …  
    3839### Preventing Access to Index (`/`) or Namespace Endpoints (`wp/v2`)
    3940
    40 To prevent anonymous users from browing your site and discovering what plugins/post types are setup, the plugin restricts access to the index (`/`) and namespace (`wp/v2`) endpoints. This can be prevented in the plugin's settings or via code:
     41To prevent anonymous users from browing your site and discovering what plugins/post types are setup, the plugin restricts access to the index (`/`) and namespace (`wp/v2`) endpoints. This can be prevented in the plugin's settings or via code:
    4142
    4243    // Allow index access.
    … …  
    5455### Limit Anonymous Access to Specific Namespaces/Routes (Allowlist)
    5556
    56 Anonymous users can be granted access only to specific namespaces/routes.
    57 Requests outside of these paths will be denied. This can be configured in the
    58 plugin's settings or via code:
     57Anonymous users can be granted access only to specific namespaces/routes. Requests outside of these paths will be denied. This can be configured in the plugin's settings or via code:
    5958
    6059    add_filter(
    … …  
    7372### Restrict Anonymous Access to Specific Namespaces/Routes (Denylist)
    7473
    75 Anonymous users can be restricted from specific namespaces/routes. This acts as
    76 a denylist for specific paths that an anonymous user cannot access. The paths
    77 support regular expressions for matching. The use of the
    78 [Allowlist](#limit-anonymous-access-to-specific-namespacesroutes-allowlist)
    79 takes priority over this denylist. This can be configured in the plugin's
    80 settings or via code:
     74Anonymous users can be restricted from specific namespaces/routes. This acts as a denylist for specific paths that an anonymous user cannot access. The paths support regular expressions for matching. The use of the [Allowlist](#limit-anonymous-access-to-specific-namespacesroutes-allowlist) takes priority over this denylist. This can be configured in the plugin's settings or via code:
    8175
    8276    add_filter(

  • rest-api-guard/trunk/readme.txt

    r2801542 r2801543  
    1818## Usage
    1919
    20 The WordPress REST API is generally very public and can share a good deal of
    21 information with the internet anonymously. This plugin aims to make it easier to
    22 restrict access to the REST API for your WordPress site.
     20The WordPress REST API is generally very public and can share a good deal of information with the internet anonymously. This plugin aims to make it easier to restrict access to the REST API for your WordPress site.
     21
     22Out of the box the plugin can:
     23
     24- Disable anonymous access to the REST API.
     25- Restrict and control anonymous access to the REST API by namespace, path, etc.
    2326
    2427### Settings Page
    2528
    26 The plugin can be configured via the Settings page (`Settings -> REST API
    27 Guard`) or via the relevant filter.
     29The plugin can be configured via the Settings page (`Settings -> REST API Guard`) or via the relevant filter.
    2830
    2931![Screenshot of plugin settings screen](https://user-images.githubusercontent.com/346399/194411352-aa05e939-3fd1-4e37-a3d5-276c1c5c288f.png)
    … …  
    3133### Preventing Access to User Information (`wp/v2/users`)
    3234
    33 By default, the plugin will restrict anonymous access to the users endpoint.
    34 This can be prevented in the plugin's settings or via code:
     35By default, the plugin will restrict anonymous access to the users endpoint. This can be prevented in the plugin's settings or via code:
    3536
    3637    add_filter( 'rest_api_guard_allow_user_access', fn () => true );
    … …  
    3839### Preventing Access to Index (`/`) or Namespace Endpoints (`wp/v2`)
    3940
    40 To prevent anonymous users from browing your site and discovering what plugins/post types are setup, the plugin restricts access to the index (`/`) and namespace (`wp/v2`) endpoints. This can be prevented in the plugin's settings or via code:
     41To prevent anonymous users from browing your site and discovering what plugins/post types are setup, the plugin restricts access to the index (`/`) and namespace (`wp/v2`) endpoints. This can be prevented in the plugin's settings or via code:
    4142
    4243    // Allow index access.
    … …  
    5455### Limit Anonymous Access to Specific Namespaces/Routes (Allowlist)
    5556
    56 Anonymous users can be granted access only to specific namespaces/routes.
    57 Requests outside of these paths will be denied. This can be configured in the
    58 plugin's settings or via code:
     57Anonymous users can be granted access only to specific namespaces/routes. Requests outside of these paths will be denied. This can be configured in the plugin's settings or via code:
    5958
    6059    add_filter(
    … …  
    7372### Restrict Anonymous Access to Specific Namespaces/Routes (Denylist)
    7473
    75 Anonymous users can be restricted from specific namespaces/routes. This acts as
    76 a denylist for specific paths that an anonymous user cannot access. The paths
    77 support regular expressions for matching. The use of the
    78 [Allowlist](#limit-anonymous-access-to-specific-namespacesroutes-allowlist)
    79 takes priority over this denylist. This can be configured in the plugin's
    80 settings or via code:
     74Anonymous users can be restricted from specific namespaces/routes. This acts as a denylist for specific paths that an anonymous user cannot access. The paths support regular expressions for matching. The use of the [Allowlist](#limit-anonymous-access-to-specific-namespacesroutes-allowlist) takes priority over this denylist. This can be configured in the plugin's settings or via code:
    8175
    8276    add_filter(
Note: See TracChangeset for help on using the changeset viewer.