Title: /well-known-uris/
Author: mrose17
Published: <strong>November 3, 2016</strong>
Last modified: November 3, 2016

---

Search plugins

This plugin **hasn’t been tested with the latest 3 major releases of WordPress**.
It may no longer be maintained or supported and may have compatibility issues when
used with more recent versions of WordPress.

![](https://s.w.org/plugins/geopattern-icon/well-known-uris.svg)

# /well-known-uris/

 By [mrose17](https://profiles.wordpress.org/mrose17/)

[Download](https://downloads.wordpress.org/plugin/well-known-uris.zip)

 * [Details](https://vec.wordpress.org/plugins/well-known-uris/#description)
 * [Reviews](https://vec.wordpress.org/plugins/well-known-uris/#reviews)
 *  [Installation](https://vec.wordpress.org/plugins/well-known-uris/#installation)
 * [Development](https://vec.wordpress.org/plugins/well-known-uris/#developers)

 [Support](https://wordpress.org/support/plugin/well-known-uris/)

## Description

This plugin enables “Well-Known URIs” support for WordPress (RFC 5785: http://tools.
ietf.org/html/rfc5785).

From the RFC:

> It is increasingly common for Web-based protocols to require the
>  discovery of
> policy or other information about a host (“site-wide metadata”) before making 
> a request. For example, the Robots Exclusion Protocol [http://www.robotstxt.org/](http://www.robotstxt.org/)
> specifies a way for automated processes to obtain permission to access resources;
> likewise, the Platform for Privacy Preferences tells user-agents how to discover
> privacy policy beforehand.
> While there are several ways to access per-resource metadata (e.g.,
>  HTTP headers,
> WebDAV’s PROPFIND [RFC4918]), the perceived overhead (either in terms of client-
> perceived latency and/or deployment difficulties) associated with them often precludes
> their use in these scenarios.
> When this happens, it is common to designate a “well-known location”
>  for such
> data, so that it can be easily located. However, this approach has the drawback
> of risking collisions, both with other such designated “well-known locations” 
> and with pre-existing resources.
> To address this, this memo defines a path prefix in HTTP(S) URIs for
>  these “well-
> known locations”, “/.well-known/”. Future specifications that need to define a
> resource for such site-wide metadata can register their use to avoid collisions
> and minimise impingement upon sites’ URI space.

You will need ‘manage_options’ capability in order to use the Settings
 page for
this plugin.

## Installation

 1. Upload the `well-known`-folder to the `/wp-content/plugins/` directory
 2. Activate the plugin through the _Plugins_ menu in WordPress
 3. If you wish to define one or more Well-Known URIs that return static output,
     go
    to _Settings > Well-Known URIs_ and define them, e.g.
 4.     ```
        Path: /.well-known/
        robots.txt
    
        Content-Type:
        text/plain; charset=utf-8
    
        URI contents:
        User-agent: *
        Allow: /
        ```
    
 5. If you want to configure a Well-Known URI that returns dynamic output,
     first, 
    edit the plugin source to define a function invoked by do_action for the action`"
    well_known_uri_" + $path`. That function will be invoked when `/.well-known/${path}`
    is requested.

## FAQ

### How can I define a well-known uri?

Set a callback for an URI (e.g., “/.well-known/robots.txt”),
 identified by `"well_known_uri_"
+ $path` (e.g., `"well_known_uri_robots.txt"`).

    ```
        add_action('well_known_uri_robots.txt', 'robots_txt');
    ```

In the callback, do whatever processing is appropriate, e.g.,

    ```
        function robots_txt($query) {
              header('Content-Type: text/plain; charset=' . get_option('blog_charset'), TRUE);
              echo "User-agent: *";
              echo "Allow: /";

              exit;
            }
    ```

This code defines a URI that returns static output, as shown in Step 3 above.
 (
For static output, you will want to use _Settings > Well-Known URIs_ page to avoid
writing any code.)

### Is there an implementation where I can write off?

Yes, you can find an example plugin, which defines a Well-Known URI,
 here: https://
wordpress.org/extend/plugins/host-meta/

## Reviews

There are no reviews for this plugin.

## Contributors & Developers

“/well-known-uris/” is open source software. The following people have contributed
to this plugin.

Contributors

 *   [ mrose17 ](https://profiles.wordpress.org/mrose17/)
 *   [ Matthias Pfefferle ](https://profiles.wordpress.org/pfefferle/)

[Translate “/well-known-uris/” into your language.](https://translate.wordpress.org/projects/wp-plugins/well-known-uris)

### Interested in development?

[Browse the code](https://plugins.trac.wordpress.org/browser/well-known-uris/), 
check out the [SVN repository](https://plugins.svn.wordpress.org/well-known-uris/),
or subscribe to the [development log](https://plugins.trac.wordpress.org/log/well-known-uris/)
by [RSS](https://plugins.trac.wordpress.org/log/well-known-uris/?limit=100&mode=stop_on_copy&format=rss).

## Changelog

#### 1.0.3

 * Fork from the original — https://wordpress.org/plugins/well-known/ —
    many thanks
   to https://profiles.wordpress.org/pfefferle/ for the excellent plugin!

## Meta

 *  Version **1.0.3**
 *  Last updated **10 years ago**
 *  Active installations **60+**
 *  WordPress version ** 3.5.1 or higher **
 *  Tested up to **4.6.30**
 *  Language
 * [English (US)](https://wordpress.org/plugins/well-known-uris/)
 * Tags
 * [discovery](https://vec.wordpress.org/plugins/tags/discovery/)[well-known](https://vec.wordpress.org/plugins/tags/well-known/)
   [well-known-uris](https://vec.wordpress.org/plugins/tags/well-known-uris/)
 *  [Advanced View](https://vec.wordpress.org/plugins/well-known-uris/advanced/)

## Ratings

No reviews have been submitted yet.

[Your review](https://wordpress.org/support/plugin/well-known-uris/reviews/#new-post)

[See all reviews](https://wordpress.org/support/plugin/well-known-uris/reviews/)

## Contributors

 *   [ mrose17 ](https://profiles.wordpress.org/mrose17/)
 *   [ Matthias Pfefferle ](https://profiles.wordpress.org/pfefferle/)

## Support

Got something to say? Need help?

 [View support forum](https://wordpress.org/support/plugin/well-known-uris/)

## Donate

Would you like to support the advancement of this plugin?

 [ Donate to this plugin ](http://www.14101978.de)