10quality/wp-file

Small class library that facilitates file handling in Wordpress.

Wordpress File (wrapper class)

, _(*1)

This small class library facilitates file handling for Wordpress custom developments, will provide all functionality to meet Wordpress' standards., _(*2)

Features: * Theme Check ready. * Easy to use., _(*3)

Installation

With composer

Make the dependecy required in your project:, _(*4)

composer require 10quality/wp-file

Alternative

Download or clone the project and load the class with php functions:, _(*5)

require_once '[PATH TO CLASS]/File.php';

Usage

The following example will let you see how to use the class:, _(*6)

Code to replace, _(*7)

$filename = __DIR__.'/myfile.txt';

$file = @fopen( $filename, ,'w+' );

$content = fread( $file );

fwrite( $file, $content );

fclose($file);

Replacement:, _(*8)

use TenQuality\WP\File;

$filename = __DIR__.'/myfile.txt';

$content = File::auth()->read( $filename );

File::auth()->write( $filename, $content );

Authentication

Wordpress will require to authenticate a url in order to validate if filesystem credentials are in place., _(*9)

If you need to authenticate a specific url, pass it like this:, _(*10)

File::auth( $url )->read( $filename );

Folder handling

Methods to handle files:, _(*11)

$file = File::auth();

// Use is_dir to check if a path exists or not.
if ( $file->is_dir( $path ) )
    // Use mkdir to create unexistent paths.
    $file->mkdir( $path );
// Use rmdir to remove paths.
$file->rmdir( $path );

Recomendations

Store your files in the uploads folder., _(*12)

Coding guidelines

PSR-4., _(*13)

LICENSE

The MIT License (MIT), _(*14)

Copyright (c) 2016 10Quality., _(*15)