inital commit

Author: Arcath

Readme.md

@@ -0,0 +1,51 @@
+# WordPress Fns
+
+A collection of functions to help with WordPress theme & plugin development.
+
+# Install
+
+Install from Composer:
+
+```bash
+composer require ed-itsolutions/wordpress-fns
+```
+
+Then add `require('vendor/autoload.php');` to the top of your `functions.php`.
+
+# Functions
+
+## wordpress_fns_as_filter($functionName, $priority = 10, $args = 1)
+
+Adds the named function `$functionName` as a filter with the same name.
+
+## wordpress_fns_featured_image_at_size($postId, $imageSize)
+
+Returns the given posts `$postId` featured image at size `$imageSize`.
+
+Returns `false` if the post does not have a featured image.
+
+## wordpress_fns_get_attachment_id_from_url($url)
+
+Returns the id of the attachment from the url. Extremely useful when working with meta boxes etc... that store an images URL instead of its attachment id.
+
+Returns `false` if no attachment could be found.
+
+## wordpress_fns_get_page_sub_menu_items($pageId, $menuName)
+
+Returns an array of menu items that are the direct desendants of the supplied page `$pageId` on the menu `$menuName`.
+
+Returns an empty array if it couldn't find the menu item for the supplied page.
+
+## wordpress_fns_header_or_featured_image($imageSize)
+
+If the page has a featured image that image at the given size `$imageSize` will be returned, otherwise it returns the header image set in the customizer.
+
+# Contributing
+
+We welcome PRs to this project. If you have a function or improvement feel free to add them.
+
+We ask that:
+
+ - All functions be prefixed with `wordpress_fns_`.
+ - All functions return `false` instead of throwing an error or null.
+ - Don't add actions or filters, if users want to use a function as a filter they can do it themselves.

composer.json

@@ -0,0 +1,19 @@
+{
+  "name": "ed-itsolutions/wordpress-fns",
+  "description": "Functions that make working with WordPress easier.",
+  "require": {
+    "php": "^5.3.3 || ^7.0"
+  },
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Adam Laycock",
+      "email": "[email protected]",
+      "homepage": "https://arcath.net",
+      "role": "Developer"
+    }
+  ],
+  "autoload": {
+    "files": ["wordpress-fns.php"]
+  }
+}

fns/as_filter.php

@@ -0,0 +1,4 @@
+<?php
+function wordpress_fns_as_filter($functionName, $priority = 10, $args = 1){
+  add_filter($functionName, $functionName, $priority, $args);
+}

fns/featured_image_at_size.php

@@ -0,0 +1,11 @@
+<?php
+function wordpress_fns_featured_image_at_size($pageId, $size){
+  $attachmentURLS = wp_get_attachment_image_src(get_post_thumbnail_id($pageId), $size);
+  $imageUrl = $attachmentURLS[0];
+
+  if($imageUrl){
+    return $imageUrl;
+  }
+
+  return false;
+}

fns/get_attachement_id_from_url.php

@@ -0,0 +1,20 @@
+<?php
+function wordpress_fns_get_attachment_id_from_url($url){
+  global $wpdb;
+
+  // Get the attachment ids from the database
+  $attachment = $wpdb->get_col(
+    $wpdb->prepare(
+      "SELECT ID FROM $wpdb->posts WHERE guid='%s';",
+      $url
+    )
+  );
+
+  // If found return the attacment
+  if(count($attachment) != 0){
+    return $attachment[0];
+  }else{
+    // Return false if not found.
+    return false;
+  }
+}

fns/get_page_sub_menu_items.php

@@ -0,0 +1,29 @@
+<?php
+function wordpress_fns_get_page_sub_menu_items($menuName, $pageId){
+  $locations = get_nav_menu_locations();
+  $menu = wp_get_nav_menu_object($locations[$menuName]);
+  $allMenuItems = wp_get_nav_menu_items($menu);
+  $menuId = 0;
+
+  // Return an empty array if no menu items could be found.
+  if(empty($allMenuItems)){
+    return array();
+  }
+
+  // Find the menu object ID for the current page.
+  foreach($allMenuItems as $item){
+    if($item->object_id == $pageId){
+      $menuId = $item->ID;
+    }
+  }
+
+  $items = array();
+
+  foreach($allMenuItems as $item){
+    if($item->menu_item_parent == $menuId){
+      $items[] = $item;
+    }
+  }
+
+  return $items;
+}

fns/header_or_featured_image.php

@@ -0,0 +1,9 @@
+<?php
+function wordpress_fns_header_or_featured_image($imageSize){
+  if(get_the_post_thumbnail(null, $size = $imageSize)){
+    $attachmentImageSrc = wp_get_attachment_image_src(get_post_thumbnail_id(), $imageSize);
+    return $attachmentImageSrc[0];
+  }
+  
+  return get_header_image();
+}

wordpress-fns.php

@@ -0,0 +1,7 @@
+<?php
+
+require_once('./fns/as_filter');
+require_once('./fns/featured_image_size.php');
+require_once('./fns/get_attachement_id_from_url.php');
+require_once('./fns/get_page_sub_menu_items.php');
+require_once('./fns/header_or_featured_image.php');