alleyinteractive/archiveless

WordPress plugin to hide posts from archives (lists)

v1.1.1 2023-04-20 19:28 UTC

Requires (Dev)

• alleyinteractive/alley-coding-standards: ^1.0
• mantle-framework/testkit: ^0.10

GPL-3.0-or-later

• Alley

README

Excludes specific WordPress posts from archives (homepage, search, date/author/term archives).

Adds <meta name='robots' content='noindex,nofollow' /> meta to the head to restrict inclusion in web searches.

Background

This plugin provides a way for content to live inside WordPress and still be accessible by a direct URL but appear hidden everywhere else. Useful for culling older content that shouldn't appear in search results because it is untimely.

Usage

By default, the plugin will prevent archiveless posts from appearing on the page. This is limited to the main query of the page. It will not affect other queries by default.

Archiveless posts can be excluded from normal queries by passing exclude_archiveless:

$query = new WP_Query(
  [
    'exclude_archiveless' => true,
    // ...
  ]
);

// Via 'pre_get_posts'.
add_action(
  'pre_get_posts',
  function ( $query ) {
    if ( special_condition() ) {
      $query->set( 'exclude_archiveless', true );
    }
  }
);

Handling archiveless posts with get_posts() calls

Queries made with get_posts() will always exclude archiveless posts by default since get_posts() sets a default post_status of publish. To include archiveless posts, you can specify the post_status of any, declare the post_status explicitly with [ 'publish', 'archiveless' ], or pass include_archiveless set to true:

// $post_ids will include archiveless posts.
$post_ids = get_posts(
  [
    'fields'              => 'ids',
    'include_archiveless' => true,
    'suppress_filters'    => false,
  ]
);

// Or declare the post_status explicitly.
$post_ids = get_posts(
  [
    'fields'              => 'ids',
    'suppress_filters'    => false,
    'post_status'         => [ 'archiveless', 'publish' ],
  ]
);

Install

The plugin includes uncompiled Javascript. You can install the plugin by tracking the main-built branch or by using a *-built tag. Otherwise, you can download the plugin and compile the assets manually:

npm install
npm run build

Changelog

Please see CHANGELOG for more information on what has changed recently.

Maintainers

This project is actively maintained by Alley Interactive. Like what you see? Come work with us.

License

This software is released under the terms of the GNU General Public License version 2 or any later version.