Description

This plugin provides template tags that allow you to retrieve the name, path (relative or absolute), url, or fully marked-up link to a randomly chosen file or files in a specified directory.

Arguments to the functions permit you to specify limit what file(s) can be randomly selected based on a given set of file extensions. You can also explicitly specify files that should not be randomly selected.

This functionality can be useful for displaying random images/logos or including text from random files onto your site (writing excerpts, multi-line quotes, etc). Other ideas: random ads, random CSS files, random theme template selection.

Notes:

• If you want to actually display the name of the random file, be sure to ‘echo’ the results:

• Unless you limit the file search to only include a particular extension (via $extensions argument), all files in the specified $dir will be under consideration for random selection

• Can be run inside or outside of “the loop”

Links: Plugin Homepage | Plugin Directory Page | GitHub | Author Homepage

Template Tags

The plugin provides two optional template tag for use in your theme templates.

Functions

• <?php function c2c_random_file( $dir, $extensions = '', $reftype = 'relative', $exclusions = array() ) ?>
  This retrieves the name of a random file from a specified directory and returns information based on the file according to the $reftype value.

• <?php function c2c_random_files( $number, $dir, $extensions = '', $reftype = 'relative', $exclusions = array() ) ?>
  This retrieves the name, path, or link to a specified number of randomly chosen files in a specified directory. All but the $number argument are passed along in calls to c2c_random_file().

Arguments

• $number (only for c2c_random_files())
  The number of random files to select from the specified directory. If less files are present in the specified directory, then all files in the directory will be returned (but will be listed in random order).

• $dir
  The directory to search for a random file. The directory must exist at the directory structure level of your WordPress installation or below. (i.e., if your site is installed on your server at /usr/local/htdocs/example.com/www/journal/, then the directory of random files you specified will assume that as its base… so a value of 'randomfiles' would be assumed to actually be: /usr/local/htdocs/example.com/www/journal/randomfiles/)

• $extensions
  Optional argument. A space-separated list of extensions (case insensitive), i.e. ‘jpg gif png jpeg’.

• $reftype
  Optional argument. Can be one of the following: ‘relative’ (which is the default), ‘absolute’, ‘url’, ‘filename’, ‘hyperlink’. See Examples section for more details and examples.

• $exclusions
  Optional argument. If specified, MUST be an array of filenames to exclude from consideration as a random file.

Examples

• The reference to the randomly selected file can be returned in one of five ways:
  [Assume your WordPress installation is at https://example.com/journal/ and you’ve invoked c2c_random_file('random/', 'txt', $reftype)]

  $reftype = ‘relative’

  => A location relative to the primary domain:

  /journal/random/randomfile.txt
  

  [This is the default setting as it is the most applicable. Relative referencing is necessary if the random file is to be used as an argument to include() or virtual(). It’s also a valid way to reference a file for A HREF= and IMG SRC= linking.]

  $reftype = 'absolute'
  

  => An absolute location relative to the root of the server’s file system:

  /usr/local/htdocs/example.com/www/journal/random/randomfile.txt
  

  $reftype = ‘url’

  => The URL of the random file:

  https://example.com/journal/random/randomfile.txt
  

  [If you desire the use of full URL, such as for a A HREF= or IMG SRC= link.]

  $reftype = ‘filename’

  => The filename of the random file:

  randomefile.txt
  

  $reftype = ‘hyperlink’

  => The filename of the random file hyperlinked to that random file:

  <a href='https://example.com/journal/random/randomfile.txt' title='randomfile.txt'>randomfile.txt</a>
  

• Include random logo or image on your site:

  <img alt="logo" class="logo" src="<?php echo c2c_random_file( 'wp-content/images/logos/' ); ?>" />
  

• Insert text from a random file (i.e. for random multi-line quotes) (Apache web-server only, probably):

• If you wanted to source a random .php file:

  <?php include( c2c_random_file( '/randomphp', 'php' ) ); ?>
  

• List 5 random files:

  <?php
  $random_files = c2c_random_files( 5, 'wp-content/files' );
  foreach ( $random_files as $f ) {
  echo "
  • $f

  “;
  }
  ?>

Hooks

The plugin exposes two filters for hooking. Typically, customizations utilizing these hooks would be put into your active theme’s functions.php file, or used by another plugin.

c2c_random_file (filter)

The ‘c2c_random_file’ hook allows you to use an alternative approach to safely invoke c2c_random_file() in such a way that if the plugin were deactivated or deleted, then your calls to the function won’t cause errors in your site.

Arguments:

• same as for c2c_random_file()

Example:

Instead of:

<?php $file = c2c_random_file( 'wp-content/randomfiles' ); ?>

Do:

<?php $file = apply_filters( 'c2c_random_file', 'wp-content/randomfiles' ); ?>

c2c_random_files (filter)

The ‘c2c_random_files’ hook allows you to use an alternative approach to safely invoke c2c_random_files() in such a way that if the plugin were deactivated or deleted, then your calls to the function won’t cause errors in your site.

Arguments:

• same as for c2c_random_files()

Example:

Instead of:

<?php $files = c2c_random_files( 5, 'wp-content/randomfiles' ); ?>

Do:

<?php $files = apply_filters( 'c2c_random_files', 5, 'wp-content/randomfiles' ); ?>