Merge pull request #19 from joshuafredrickson/master

erwstout · web-flow · commit e091b1714262 · 2018-06-05T15:55:16.000-07:00
Add support for Yoast SEO fields, update how slugs are populated
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ Gets a collection of posts. Accepts the following parameters:
 - exclude (int) a post ID to exclude from the response
 - author (string) limit posts by author nice name (user_nicename)
 - acf (boolean - setting to false omits `acf` from being returned)
+- yoast (boolean - setting to false omits `yoast` from being returned)
 - media (boolean - setting to false omits `media` (featured media) from being returned)
 
 It returns a JSON response with the following:
@@ -34,6 +35,7 @@ It returns a JSON response with the following:
 - Tags
 - Tag IDs
 - ACF fields, if applicable
+- Yoast SEO fields, if applicable
 
 ### Post
 **`better-rest-endpoints/v1/post/{id}`**
@@ -58,6 +60,7 @@ Returns a JSON response with the following:
 - Tags
 - Tag IDs
 - ACF fields, if applicable
+- Yoast SEO fields, if applicable
 
 ### Post by slug
 **`better-rest-endpoints/v1/post/{slug}`**
@@ -82,6 +85,7 @@ Returns a JSON response with the following:
 - Tags
 - Tag IDs
 - ACF fields, if applicable
+- Yoast SEO fields, if applicable
 
 ### Pages
 **`better-rest-endpoints/v1/pages`**
@@ -95,6 +99,7 @@ Gets a collection of pages. Accepts the following parameters:
 - content (boolean - setting to false hides the content from the response)
 - exclude (int) a post ID to exclude from the response
 - acf (boolean - setting to false omits `acf` from being returned)
+- yoast (boolean - setting to false omits `yoast` from being returned)
 - media (boolean - setting to false omits `media` (featured media) from being returned)
 
 Returns the following JSON Response:
@@ -105,6 +110,7 @@ Returns the following JSON Response:
 - Title
 - Content
 - ACF Fields
+- Yoast SEO Fields
 - all possible thumbnail sizes & URLs
 
 ### Page by ID
@@ -124,6 +130,7 @@ Returns a JSON response with the following:
 - content
 - all possible thumbnail sizes & URLs
 - ACF fields, if applicable
+- Yoast SEO fields, if applicable
 
 ### Custom Post Type Collection
 **`better-rest-endpoints/v1/{custom_post_type}`**
@@ -135,6 +142,7 @@ Gets a collection of posts from a custom post type. Accepts the following parame
 - orderby (string) - see the [codex](https://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters) for options, currently does not support multiple values
 - exclude (int) a post ID to exclude from the response
 - acf (boolean - setting to false omits `acf` from being returned)
+- yoast (boolean - setting to false omits `yoast` from being returned)
 - media (boolean - setting to false omits `media` (featured media) from being returned)
 
 Returns the following JSON response:
@@ -149,6 +157,7 @@ Returns the following JSON response:
 - all possible thumbnail sizes & URLs
 - Author, user_nicename, & Author ID
 - ACF fields if applicable
+- Yoast SEO fields if applicable
 
 ### Custom Post Type Post by ID
 **`better-rest-endpoints/v1/{custom_post_type}/{id}`**
@@ -168,6 +177,7 @@ Returns the following JSON Response:
 - all possible thumbnail sizes & URLs
 - Author, user_nicename, & Author ID
 - ACF Fields, if applicable
+- Yoast SEO Fields, if applicable
 
 ### Custom Post Type Post by Slug
 **`better-rest-endpoints/v1/{custom_post_type}/{slug}`**
@@ -187,6 +197,7 @@ Returns the following JSON Response:
 - all possible thumbnail sizes & URLs
 - Author, user_nicename, & Author ID
 - ACF Fields, if applicable
+- Yoast SEO Fields, if applicable
 
 ### Get Posts Belonging To A Taxonomy Term
 **`better-rest-endpoints/v1/{taxonomy}/{term}`**
@@ -198,6 +209,7 @@ Gets posts from a taxonomy term. Accepts the following parameters:
 - orderby (string) - see the [codex](https://codex.wordpress.org/Class_Reference/WP_Query#Order_.26_Orderby_Parameters) for options, currently does not support multiple values
 - exclude (int) a post ID to exclude from the response
 - acf (boolean - setting to false omits `acf` from being returned)
+- yoast (boolean - setting to false omits `yoast` from being returned)
 - media (boolean - setting to false omits `media` (featured media) from being returned)
 
 Returns the following JSON Response:
@@ -212,6 +224,7 @@ Returns the following JSON Response:
 - all possible thumbnail sizes & URLs
 - Author, user_nicename, & Author ID
 - ACF Fields, if applicable
+- Yoast SEO Fields, if applicable
 
 ### Menus
 **`better-rest-endpoints/v1/menus/{menu-slug}`**
@@ -251,6 +264,7 @@ Gets a collection of posts and pages based on the search parameter. Accepts the
 - content (boolean) set to false to omit content from showing in JSON response
 - search (string | required)
 - acf (boolean - setting to false omits `acf` from being returned)
+- yoast (boolean - setting to false omits `yoast` from being returned)
 - media (boolean - setting to false omits `media` (featured media) from being returned)
 
 It returns a JSON response with the following (returns an empty array if no posts found):
@@ -267,6 +281,7 @@ It returns a JSON response with the following (returns an empty array if no post
 - Tags
 - Tag IDs
 - ACF fields, if applicable
+- Yoast SEO fields, if applicable
 
 ## Hooks and Filters
 
@@ -282,4 +297,4 @@ add_filter('better_rest_endpoints_cpt_collection', function($cpt_collection){
 	$cpt_collection = array_values( array_flip($cpt_collection) );
 	return $cpt_collection;
 });
-```
+```
diff --git a/better-rest-endpoints.php b/better-rest-endpoints.php
@@ -74,6 +74,9 @@ private function includes() {
 		// include acf function
 		include_once self::$plugin_dir . 'includes/get_acf.php';
 
+		// include yoast seo function
+		include_once self::$plugin_dir . 'includes/get_yoast.php';
+
 		// get a post by id
 		include_once self::$plugin_dir . 'includes/get_post_by_id.php';
 
diff --git a/includes/create_cpt_endpoints.php b/includes/create_cpt_endpoints.php
@@ -30,6 +30,8 @@ function bre_build_cpt_endpoints() {
             $show_content = filter_var($content, FILTER_VALIDATE_BOOLEAN);
             $acf = $request['acf'];
             $show_acf = filter_var($acf, FILTER_VALIDATE_BOOLEAN);
+            $yoast = $request['yoast'];
+            $show_yoast = filter_var($yoast, FILTER_VALIDATE_BOOLEAN);
             $media = $request['media'];
             $show_media = filter_var($media, FILTER_VALIDATE_BOOLEAN);
             $orderby = $request['orderby']?: null;
@@ -63,14 +65,16 @@ function bre_build_cpt_endpoints() {
             	while ( $query->have_posts() ) {
             		$query->the_post();
 
+                global $post;
+
                 // better wordpress endpoint post object
                 $bre_post = new stdClass();
 
                 // get post data
                 $permalink = get_permalink();
                 $bre_post->id = get_the_ID();
                 $bre_post->title = get_the_title();
-                $bre_post->slug = basename($permalink);
+                $bre_post->slug = $post->post_name;
                 $bre_post->permalink = $permalink;
                 $bre_post->date = get_the_date('c');
                 $bre_post->excerpt = get_the_excerpt();
@@ -107,6 +111,15 @@ function bre_build_cpt_endpoints() {
                   $bre_post->acf = bre_get_acf();
                 }
 
+                /*
+                 *
+                 * return Yoast SEO fields if they exist and depending on query string
+                 *
+                 */
+                if( $yoast === null || $show_yoast === true ) {
+                  $bre_post->yoast = bre_get_yoast( $bre_post->id );
+                }
+
                 /*
                  *
                  * get possible thumbnail sizes and urls if query set to true or by default
@@ -192,6 +205,20 @@ function bre_build_cpt_endpoints() {
                 return is_bool( $param );
                }
             ),
+            'yoast' =>  array(
+              'description'       => 'Hide or show Yoast SEO fields from the collection.',
+              'type'              => 'boolean',
+              'validate_callback' => function( $param, $request, $key ) {
+
+                if ( $param == 'true' || $param == 'TRUE' ) {
+                  $param = true;
+                } else if( $param == 'false' || $param == 'FALSE') {
+                  $param = false;
+                }
+
+                return is_bool( $param );
+               }
+            ),
             'order' =>  array(
               'description'       => 'Change order of the collection.',
               'type'              => 'string',
diff --git a/includes/get_cpt_by_id.php b/includes/get_cpt_by_id.php
@@ -44,12 +44,13 @@ function bre_build_single_cpt_endpoints() {
               while( $query->have_posts() ) {
                 $query->the_post();
 
+                global $post;
 
                 // get post data
                 $permalink = get_permalink();
                 $bre_cpt_post->id = get_the_ID();
                 $bre_cpt_post->title = get_the_title();
-                $bre_cpt_post->slug = basename($permalink);
+                $bre_cpt_post->slug = $post->post_name;
                 $bre_cpt_post->permalink = $permalink;
                 $bre_cpt_post->date = get_the_date('c');
                 $bre_cpt_post->excerpt = get_the_excerpt();
@@ -80,6 +81,13 @@ function bre_build_single_cpt_endpoints() {
                  */
                 $bre_cpt_post->acf = bre_get_acf();
 
+                /*
+                 *
+                 * return Yoast SEO fields if they exist
+                 *
+                 */
+                $bre_cpt_post->yoast = bre_get_yoast( $bre_cpt_post->id );
+
                 /*
                  *
                  * get possible thumbnail sizes and urls
diff --git a/includes/get_cpt_by_slug.php b/includes/get_cpt_by_slug.php
@@ -44,12 +44,13 @@ function bre_build_single_cpt_endpoints_slug() {
               while( $query->have_posts() ) {
                 $query->the_post();
 
+                global $post;
 
                 // get post data
                 $permalink = get_permalink();
                 $bre_cpt_post->id = get_the_ID();
                 $bre_cpt_post->title = get_the_title();
-                $bre_cpt_post->slug = basename($permalink);
+                $bre_cpt_post->slug = $post->post_name;
                 $bre_cpt_post->permalink = $permalink;
                 $bre_cpt_post->date = get_the_date('c');
                 $bre_cpt_post->excerpt = get_the_excerpt();
@@ -80,6 +81,13 @@ function bre_build_single_cpt_endpoints_slug() {
                  */
                 $bre_cpt_post->acf = bre_get_acf();
 
+                /*
+                 *
+                 * return Yoast SEO fields if they exist
+                 *
+                 */
+                $bre_cpt_post->yoast = bre_get_yoast( $bre_cpt_post->id );
+
                 /*
                  *
                  * get possible thumbnail sizes and urls
diff --git a/includes/get_page_by_id.php b/includes/get_page_by_id.php
@@ -29,7 +29,7 @@ function get_page_by_id( WP_REST_Request $request ){
       $permalink = get_permalink();
       $bre_page->id = get_the_ID();
       $bre_page->title = get_the_title();
-      $bre_page->slug = basename($permalink);
+      $bre_page->slug = $post->post_name;
       $bre_page->permalink = $permalink;
 
       /*
@@ -68,6 +68,13 @@ function get_page_by_id( WP_REST_Request $request ){
        */
       $bre_page->acf = bre_get_acf();
 
+      /*
+       *
+       * return Yoast SEO fields if they exist
+       *
+       */
+      $bre_page->yoast = bre_get_yoast( $bre_page->id );
+
       /*
        *
        * get possible thumbnail sizes and urls
diff --git a/includes/get_pages.php b/includes/get_pages.php
@@ -17,6 +17,8 @@ function bre_get_pages( WP_REST_Request $request ) {
   $show_content = filter_var($content, FILTER_VALIDATE_BOOLEAN);
   $acf = $request['acf'];
   $show_acf = filter_var($acf, FILTER_VALIDATE_BOOLEAN);
+  $yoast = $request['yoast'];
+  $show_yoast = filter_var($yoast, FILTER_VALIDATE_BOOLEAN);
   $media = $request['media'];
   $show_media = filter_var($media, FILTER_VALIDATE_BOOLEAN);
   $orderby = $request['orderby']?: null;
@@ -62,7 +64,7 @@ function bre_get_pages( WP_REST_Request $request ) {
       $permalink = get_permalink();
       $bre_page->id = get_the_ID();
       $bre_page->title = get_the_title();
-      $bre_page->slug = basename($permalink);
+      $bre_page->slug = $post->post_name;
       $bre_page->permalink = $permalink;
 
       /*
@@ -107,6 +109,15 @@ function bre_get_pages( WP_REST_Request $request ) {
          $bre_page->acf = bre_get_acf();
        }
 
+      /*
+       *
+       * return Yoast SEO fields if they exist
+       *
+       */
+       if( $yoast === null || $show_yoast === true ) {
+         $bre_page->yoast = bre_get_yoast( $bre_page->id );
+       }
+
        /*
         *
         * get possible thumbnail sizes and urls if query set to true or by default
@@ -229,6 +240,20 @@ function bre_get_pages( WP_REST_Request $request ) {
            return is_bool( $param );
           }
        ),
+       'yoast' =>  array(
+         'description'       => 'Hide or show Yoast SEO fields from the collection.',
+         'type'              => 'boolean',
+         'validate_callback' => function( $param, $request, $key ) {
+
+           if ( $param == 'true' || $param == 'TRUE' ) {
+             $param = true;
+           } else if( $param == 'false' || $param == 'FALSE') {
+             $param = false;
+           }
+
+           return is_bool( $param );
+          }
+       ),
        'media' =>  array(
          'description'       => 'Hide or show featured media from the collection.',
          'type'              => 'boolean',
diff --git a/includes/get_post_by_id.php b/includes/get_post_by_id.php
@@ -21,13 +21,15 @@ function get_post_by_id( $data ) {
   	while ( $query->have_posts() ) {
   		$query->the_post();
 
+      global $post;
+
       // better wordpress endpoint post object
       $bre_post = new stdClass();
 
       $permalink = get_permalink();
       $bre_post->id = get_the_ID();
       $bre_post->title = get_the_title();
-      $bre_post->slug = basename($permalink);
+      $bre_post->slug = $post->post_name;
       $bre_post->permalink = $permalink;
       $bre_post->date = get_the_date('c');
       $bre_post->excerpt = get_the_excerpt();
@@ -83,6 +85,13 @@ function get_post_by_id( $data ) {
        */
       $bre_post->acf = bre_get_acf();
 
+      /*
+       *
+       * return Yoast SEO fields if they exist
+       *
+       */
+      $bre_post->yoast = bre_get_yoast( $bre_post->id );
+
       /*
        *
        * get possible thumbnail sizes and urls
diff --git a/includes/get_post_by_slug.php b/includes/get_post_by_slug.php
@@ -23,13 +23,15 @@ function get_post_by_slug( WP_REST_Request $request ) {
   	while ( $query->have_posts() ) {
   		$query->the_post();
 
+      global $post;
+
       // better wordpress endpoint post object
       $bre_post = new stdClass();
 
       $permalink = get_permalink();
       $bre_post->id = get_the_ID();
       $bre_post->title = get_the_title();
-      $bre_post->slug = basename($permalink);
+      $bre_post->slug = $post->post_name;
       $bre_post->permalink = $permalink;
       $bre_post->date = get_the_date('c');
       $bre_post->excerpt = get_the_excerpt();
@@ -85,6 +87,13 @@ function get_post_by_slug( WP_REST_Request $request ) {
        */
       $bre_post->acf = bre_get_acf();
 
+      /*
+       *
+       * return Yoast SEO fields if they exist
+       *
+       */
+      $bre_post->yoast = bre_get_yoast( $bre_post->id );
+
       /*
        *
        * get possible thumbnail sizes and urls
diff --git a/includes/get_posts.php b/includes/get_posts.php
diff --git a/includes/get_posts_tax.php b/includes/get_posts_tax.php
diff --git a/includes/get_search.php b/includes/get_search.php
diff --git a/includes/get_yoast.php b/includes/get_yoast.php
