PHP Archives - JBoullion

file_get_contents cURL replacement

Some hosting providers disable file() and file_get_contents() by default. However, cURL should still be available. If that is the case you can use this function as a replacement for file_get_contents().

function file_get_contents_curl($url) {
    $ch = curl_init();

    curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE);
    curl_setopt($ch, CURLOPT_HEADER, 0);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);       

    $data = curl_exec($ch);
    curl_close($ch);

    return $data;
}

function file_get_contents_curl($url) {

$ch = curl_init();

curl_setopt($ch, CURLOPT_AUTOREFERER, TRUE);

curl_setopt($ch, CURLOPT_HEADER, 0);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_URL, $url);

curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);

$data = curl_exec($ch);

curl_close($ch);

return $data;

}

Upload a PDF from URL

We often have to do a lot of imports from old databases / sites. This means getting images and other files and adding them to the new site’s media library and attaching them to the new post that is related to the old site’s object / page / post. With images I always used media_sideload_image and that is easy enough.

media_sideload_image example:

//create a new post
$new_post = array(
	'post_title'  => $post_title,
	'post_content'=> '',
	'post_status' => 'publish',
	'post_author' => 1,
	'post_type' 	=> 'post-type',
	'comment_status' => 'closed'
);

// Insert the post into the database
$post_id = wp_insert_post( $new_post );

//grab an image from the old site to attach to this new post
$img_url = 'http://www.oldsite.com/images/filename.jpg';
if(url_exists($img_url)){
	media_sideload_image($img_url, $post_id);
	
	$attachment = get_posts( array(
            'post_type' => 'attachment',
            'number_posts' => 1,
            'post_status' => null,
            'post_parent' => $post_id,
            'orderby' => 'post_date',
            'order' => 'DESC',) 
        );
    
        //regular post meta data
        //add_post_meta( $post_id, 'meta_name', $attachments[0]->ID );
	
        //Advanced Custom Field				
	update_field( 'field_56b26df0d98a3', $attachment[0]->ID, $post_id);
}

//create a new post

$new_post = array(

'post_title' => $post_title,

'post_content'=> '',

'post_status' => 'publish',

'post_author' => 1,

'post_type' => 'post-type',

'comment_status' => 'closed'

);

// Insert the post into the database

$post_id = wp_insert_post( $new_post );

//grab an image from the old site to attach to this new post

$img_url = 'http://www.oldsite.com/images/filename.jpg';

if(url_exists($img_url)){

media_sideload_image($img_url, $post_id);

$attachment = get_posts( array(

'post_type' => 'attachment',

'number_posts' => 1,

'post_status' => null,

'post_parent' => $post_id,

'orderby' => 'post_date',

'order' => 'DESC',)

);

//regular post meta data

//add_post_meta( $post_id, 'meta_name', $attachments[0]->ID );

//Advanced Custom Field

update_field( 'field_56b26df0d98a3', $attachment[0]->ID, $post_id);

}

So that works well enough for images. However, if you want to upload any other file types, like PDFs, you need to use a different approach.

//https://codex.wordpress.org/Function_Reference/media_handle_sideload

$pdf_url = 'http://www.oldsite.com/docs/filename.pdf';
if(url_exists($pdf_url)){
	$file_array = array();

        //download the pdf to our server temporarily
	$tmp = download_url( $pdf_url );

	// Set variables for storage
	$file_array['name'] = basename($pdf_url);
	$file_array['tmp_name'] = $tmp;

	// do the validation and storage stuff
	$pdfID = media_handle_sideload( $file_array, $post_id, 'PDF Name' );

	//attach to the post
	update_field( 'field_58a74132288a4', $pdfID, $post_id); 
}

//https://codex.wordpress.org/Function_Reference/media_handle_sideload

$pdf_url = 'http://www.oldsite.com/docs/filename.pdf';

if(url_exists($pdf_url)){

$file_array = array();

//download the pdf to our server temporarily

$tmp = download_url( $pdf_url );

// Set variables for storage

$file_array['name'] = basename($pdf_url);

$file_array['tmp_name'] = $tmp;

// do the validation and storage stuff

$pdfID = media_handle_sideload( $file_array, $post_id, 'PDF Name' );

//attach to the post

update_field( 'field_58a74132288a4', $pdfID, $post_id);

}

There we go! Between those 2 functions above you can upload pretty much anything with a valid URL to your media library!

NOTE: I am also using another function called url_exists(). This is a simple function that just checks to make sure there is actually something being returned from the given URL.

function url_exists($url){
	$ch = curl_init($url);    
	curl_setopt($ch, CURLOPT_NOBODY, true);
	curl_exec($ch);
	$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

	if($code == 200){
		$status = true;
	}else{
		$status = false;
	}
	curl_close($ch);
	return $status;
}

function url_exists($url){

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_NOBODY, true);

curl_exec($ch);

$code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if($code == 200){

$status = true;

}else{

$status = false;

}

curl_close($ch);

return $status;

}

FINAL NOTE: Obviously I didn’t wrap most of the above code in a function but I do usually convert the above code to a function for easier use. Feel free to set that up for yourself…or not 🙂

WordPress Static Variables

Sometimes I want to setup some variables to be used across various scripts and I don’t want to have to pollute the global variables. We setup some functionality in house for creating variables we can use throughout our scripts in a site.

// get a static value
function jb_get($key) {
	return jb_value($key);
}
	
// set a static value -- returns previous value
function jb_set($key, $value=null) {
	return jb_value($key, $value);
}
	
// get/set a static value
function jb_value() {
	static $list = array();
	
	// initialize value
	$value = null;
	
	// 1 argument = get, 2 arguments = set, anything else = invalid
	switch(func_num_args()) {
	
		// get value
		case 1:
			$key = func_get_arg(0);
			if(is_string($key)) {
				$value = (isset($list[$key]) ? $list[$key] : null);
			}
			break;
			
		// set value (and return old value)
		case 2:
			$key = func_get_arg(0);
			if(is_string($key)) {
				$value = (isset($list[$key]) ? $list[$key] : null);
				$list[$key] = func_get_arg(1);
			}
			break;
		
		// invalid usage
		default:
			break;
	}
	
	// return current/previous value
	return $value;
}

// get a static value

function jb_get($key) {

return jb_value($key);

}

// set a static value -- returns previous value

function jb_set($key, $value=null) {

return jb_value($key, $value);

}

// get/set a static value

function jb_value() {

static $list = array();

// initialize value

$value = null;

// 1 argument = get, 2 arguments = set, anything else = invalid

switch(func_num_args()) {

// get value

case 1:

$key = func_get_arg(0);

if(is_string($key)) {

$value = (isset($list[$key]) ? $list[$key] : null);

}

break;

// set value (and return old value)

case 2:

$key = func_get_arg(0);

if(is_string($key)) {

$value = (isset($list[$key]) ? $list[$key] : null);

$list[$key] = func_get_arg(1);

}

break;

// invalid usage

default:

break;

}

// return current/previous value

return $value;

}

Now you can set and get any variable you want throughout your scripts.

Array Splice Associative

Sometimes I want to put an array into another array at a certain position. array_splice works for regular arrays, but does not keep the keys. Here is a function that will work like array splice, BUT it will maintain the keys.

/**
 * Insert an associative array into a specific position in an array
 *
 * @param $original array 	The original array to add to
 * @param $new array 		The new array of values to insert into the original
 * @param $offset int 		The position in the array ( 0 index ) where the new array should go
 *
 * @return array 		The new combined array
 */
function jb_array_splice_assoc($original,$new,$offset) {
    return array_slice($original, 0, $offset, true) + $new + array_slice($original, $offset, NULL, true);  
}

//USAGE
$combined = jb_array_splice_assoc($original, array('key' => 'value'), 4);

/**

* Insert an associative array into a specific position in an array

* @param $original array The original array to add to

* @param $new array The new array of values to insert into the original

* @param $offset int The position in the array ( 0 index ) where the new array should go

* @return array The new combined array

function jb_array_splice_assoc($original,$new,$offset) {

return array_slice($original, 0, $offset, true) + $new + array_slice($original, $offset, NULL, true);

}

//USAGE

$combined = jb_array_splice_assoc($original, array('key' => 'value'), 4);

Attach a Server File to a Post

Like the last post, sometimes what we want isn’t to attach an uploaded file, but perhaps some setup files or other default image files that we know will need to get setup on a page. Here is a function for that.

  /**
   * Moves one of the default images from the setup folder into the correct site folder
   * 
   * @param string $setup_file should be the filename of the default file to move
   * @param int $post_id should be the ID of the post we want to attach this to
   * @return boolean returns true/false
   */
  function jb_move_setup_files($setup_file, $post_id){
    if(! empty($setup_file)){
      // Get the path to the upload directory.
      $wp_upload_dir = wp_upload_dir();

      //location of some default images. You will likely need to change this to your default location
      $setup_dir = ABSPATH.'wp-content/uploads/setup/';

      // $setup_file should be the path to a file in the uploads/setup directory.
      $setup_file = $setup_dir.$setup_file;

      // $site_file should be the path to the new site directory.
      $site_file = $wp_upload_dir['path'] . '/' . basename( $setup_file );

      // COPY this file into the new sites upload dir
      copy($setup_file, $site_file);

      // Check the type of file. We'll use this as the 'post_mime_type'.
      $filetype = wp_check_filetype( basename( $site_file ), null );

      // Prepare an array of post data for the attachment.
      $attachment = array(
        'guid'           => $site_file, 
        'post_mime_type' => $filetype['type'],
        'post_title'     => preg_replace( '/\.[^.]+$/', '', basename( $site_file ) ),
        'post_content'   => '',
        'post_status'    => 'inherit'
      );

      // Insert the attachment.
      $attach_id = wp_insert_attachment( $attachment, $site_file, $post_id );

      // Generate the metadata for the attachment, and update the database record.
      $attach_data = wp_generate_attachment_metadata( $attach_id, $site_file );

      $success = wp_update_attachment_metadata( $attach_id, $attach_data );

      //return the attachment id so we can attach this to whatever we want
      if($success){
        return $attach_id;
      }else{
        return false;
      }
    }else{
      //no filename given
      return false;
    }
  }

/**

* Moves one of the default images from the setup folder into the correct site folder

* @param string $setup_file should be the filename of the default file to move

* @param int $post_id should be the ID of the post we want to attach this to

* @return boolean returns true/false

function jb_move_setup_files($setup_file, $post_id){

if(! empty($setup_file)){

// Get the path to the upload directory.

$wp_upload_dir = wp_upload_dir();

//location of some default images. You will likely need to change this to your default location

$setup_dir = ABSPATH.'wp-content/uploads/setup/';

// $setup_file should be the path to a file in the uploads/setup directory.

$setup_file = $setup_dir.$setup_file;

// $site_file should be the path to the new site directory.

$site_file = $wp_upload_dir['path'] . '/' . basename( $setup_file );

// COPY this file into the new sites upload dir

copy($setup_file, $site_file);

// Check the type of file. We'll use this as the 'post_mime_type'.

$filetype = wp_check_filetype( basename( $site_file ), null );

// Prepare an array of post data for the attachment.

$attachment = array(

'guid' => $site_file,

'post_mime_type' => $filetype['type'],

'post_title' => preg_replace( '/\.[^.]+$/', '', basename( $site_file ) ),

'post_content' => '',

'post_status' => 'inherit'

);

// Insert the attachment.

$attach_id = wp_insert_attachment( $attachment, $site_file, $post_id );

// Generate the metadata for the attachment, and update the database record.

$attach_data = wp_generate_attachment_metadata( $attach_id, $site_file );

$success = wp_update_attachment_metadata( $attach_id, $attach_data );

//return the attachment id so we can attach this to whatever we want

if($success){

return $attach_id;

}else{

return false;

}

}else{

//no filename given

return false;

}

Now all we need to do to attach this image is call the function like so:

$attach_id = jb_move_setup_files('my-setup-image.jpg', $post_ID);

1	$attach_id = jb_move_setup_files('my-setup-image.jpg', $post_ID);

Attach an uploaded file

Sometimes when spinning up a new site, especially a multi-site, you need to make sure to populate some attachments. Here is a function to make this easier.

  /**
   * Moves one of the default images from the setup folder into the correct site folder
   * 
   * @param array $file the information about this file from the $_FILES array
   * @param int $post_id should be the ID of the post we want to attach this to
   * @return boolean returns true/false
   */
  function jb_move_uploaded_files($file, $post_id){
    // Get the path to the upload directory.
    $wp_upload_dir = wp_upload_dir();

    // Check the type of file. We'll use this as the 'post_mime_type'.
    $filetype = wp_check_filetype( basename( $file['name'] ), null );

    // $site_file should be the path to the new site directory.
    $site_file = $wp_upload_dir['path'] . '/' . $file['name'];

    move_uploaded_file($file['tmp_name'], $site_file);

    // Prepare an array of post data for the attachment.
    $attachment = array(
      'guid'           => $site_file, 
      'post_mime_type' => $filetype['type'],
      'post_title'     => preg_replace( '/\.[^.]+$/', '', basename( $site_file ) ),
      'post_content'   => '',
      'post_status'    => 'inherit'
    );

    // Insert the attachment.
    $attach_id = wp_insert_attachment( $attachment, $site_file, $post_id);

    // Generate the metadata for the attachment, and update the database record.
    $attach_data = wp_generate_attachment_metadata( $attach_id, $site_file );

    $success = wp_update_attachment_metadata( $attach_id, $attach_data );

    if($success){
      return $attach_id;
    }else{
      return false;
    }
  }

/**

* Moves one of the default images from the setup folder into the correct site folder

* @param array $file the information about this file from the $_FILES array

* @param int $post_id should be the ID of the post we want to attach this to

* @return boolean returns true/false

function jb_move_uploaded_files($file, $post_id){

// Get the path to the upload directory.

$wp_upload_dir = wp_upload_dir();

// Check the type of file. We'll use this as the 'post_mime_type'.

$filetype = wp_check_filetype( basename( $file['name'] ), null );

// $site_file should be the path to the new site directory.

$site_file = $wp_upload_dir['path'] . '/' . $file['name'];

move_uploaded_file($file['tmp_name'], $site_file);

// Prepare an array of post data for the attachment.

$attachment = array(

'guid' => $site_file,

'post_mime_type' => $filetype['type'],

'post_title' => preg_replace( '/\.[^.]+$/', '', basename( $site_file ) ),

'post_content' => '',

'post_status' => 'inherit'

);

// Insert the attachment.

$attach_id = wp_insert_attachment( $attachment, $site_file, $post_id);

// Generate the metadata for the attachment, and update the database record.

$attach_data = wp_generate_attachment_metadata( $attach_id, $site_file );

$success = wp_update_attachment_metadata( $attach_id, $attach_data );

if($success){

return $attach_id;

}else{

return false;

}

If you want to do this for a single file upload you can call this function like so:

//post_id left at 0 just means it is not attached to anything
$attach_id = jb_move_uploaded_files($_FILE['single_file'], 0);

//here we can attach this file to some ACF field in one of our options pages
//update_field( 'field_56cf1a4cd46b3', $attach_id, 'options');

//post_id left at 0 just means it is not attached to anything

$attach_id = jb_move_uploaded_files($_FILE['single_file'], 0);

//here we can attach this file to some ACF field in one of our options pages

//update_field( 'field_56cf1a4cd46b3', $attach_id, 'options');

If you want to use this to upload multiple files in an upload:

$files = $_FILES['multiple_images'];
    
foreach ($files['name'] as $key => $value) {
      if ($files['name'][$key]) {

        $file = array(
          'name'     => $files['name'][$key],
          'type'     => $files['type'][$key],
          'tmp_name' => $files['tmp_name'][$key],
          'error'    => $files['error'][$key],
          'size'     => $files['size'][$key]
        );

        $attach_id = jb_move_uploaded_files($file, $home->ID);

        if(is_numeric($attach_id) ){
          $attchment_ids[] = $attach_id;
        }
      }
    }

//if you want to setup an ACF gallery you can just set that field key here and use the attachment array we generated
//update_field( 'field_56d5b31c5b094', $attchment_ids, $post_ID );

$files = $_FILES['multiple_images'];

foreach ($files['name'] as $key => $value) {

if ($files['name'][$key]) {

$file = array(

'name' => $files['name'][$key],

'type' => $files['type'][$key],

'tmp_name' => $files['tmp_name'][$key],

'error' => $files['error'][$key],

'size' => $files['size'][$key]

);

$attach_id = jb_move_uploaded_files($file, $home->ID);

if(is_numeric($attach_id) ){

$attchment_ids[] = $attach_id;

}

//if you want to setup an ACF gallery you can just set that field key here and use the attachment array we generated

//update_field( 'field_56d5b31c5b094', $attchment_ids, $post_ID );