Merge pull request #26 from circuscode/develop

Version 0.4

Author: circuscode

readme.md

@@ -99,7 +99,36 @@ TootPress creates 2 folders within the WordPress Uploads Directory.
 
 ## TootPress API
 
-WordPress Action: tootpress_toots_update (fired on toot update)
+### Actions
+
+#### tootpress_toots_update
+
+This action will be fired after toot update to execute custom post-processing.  
+You can use the following code.
+
+    function tootpress_toots_update_postprocessing() {
+
+        // Add your code to be executed here
+
+    }
+    add_action('tootpress_toots_update', 'tootpress_toots_update_postprocessing');
+
+### Filter
+
+#### tootpress_preamble_add
+
+This filter outputs html content before the toot loop.  
+You can use the following code.
+
+    function tootpress_preamble_add( $preamble ) {
+
+        // Add your filter code here
+        // Example: $preamble='<p>Hello World.</p>';
+
+        return $preamble;
+
+    }
+    add_filter( 'tootpress_preamble_filter', 'tootpress_preamble_add', 10, 1 );
 
 ## WordPress Framework
 
@@ -116,6 +145,7 @@ Following components of WordPress are used in TootPress.
 * File Functions
 * Content Functions
 * Escaping Functions
+* Hooks
 
 ## Frequently Asked Questions
 
@@ -177,6 +207,11 @@ This project is licensed under the GPL3 License.
 
 ## Changelog
 
+### 0.4 "Cassie Lang"
+
+* June 2024
+* Feature: Preamble Filter
+
 ### 0.3 "Deadpool"
 
 * April 2024

readme.txt

@@ -3,7 +3,7 @@ Contributors: unmus
 Tags: mastodon, toots, microblogging, blog, fediverse
 Requires at least: 6.1
 Tested up to: 6.5
-Stable tag: 0.3
+Stable tag: 0.4
 License: GNU General Public License v3 or later
 License URI: https://www.gnu.org/licenses/gpl-3.0.html
 
@@ -105,7 +105,30 @@ TootPress creates 2 folders within the WordPress Uploads Directory.
 
 = TootPress API =
 
-WordPress Action: tootpress_toots_update (fired on toot update)
+**Action: tootpress_toots_update**  
+It will be fired after toot update to execute custom post-processing.  
+You can use the following code.
+
+`function tootpress_toots_update_postprocessing() {`
+``
+`    // Add your code to be executed here`
+``
+`}`
+`add_action('tootpress_toots_update', 'tootpress_toots_update_postprocessing');`
+
+**Filter: tootpress_preamble_add**  
+It outputs html content before the toot loop.  
+You can use the following code.
+
+`function tootpress_preamble_add( $preamble ) {`
+``
+`    // Add your filter code here`
+`    // Example: $preamble='<p>Hello World.</p>';`
+``
+`    return $preamble;`
+``
+`}`
+`add_filter( 'tootpress_preamble_filter', 'tootpress_preamble_add', 10, 1 );`
 
 = Related Links =
 
@@ -142,6 +165,11 @@ No. TootPress does not support the WordPress Multisite Feature. The plugin is wo
 
 == Changelog ==
 
+= 0.4 "Cassie Lang" =
+
+* June 2024
+* Feature: Preamble Filter
+
 = 0.3 "Deadpool" =
 
 * April 2024
@@ -172,6 +200,9 @@ No. TootPress does not support the WordPress Multisite Feature. The plugin is wo
 
 == Upgrade Notice ==
 
+= 0.4 =
+This version includes a preamble filter.
+
 = 0.3 =
 This version brings gallery support and contains major bugfixes.
 

tootpress.php

@@ -3,7 +3,7 @@
 /*
 Plugin Name:  TootPress
 Description:  TootPress copies your Toots from Mastodon to WordPress.
-Version:	  0.3
+Version:	  0.4
 Author:       Marco Hitschler
 Author URI:   https://www.unmus.de/
 License:      GPL3

tootpress_blog.php

@@ -154,4 +154,31 @@ function tootpress_paint_elephant( $instance, $account, $mastodon_id, $backlink)
 
 }
 
+/**
+ * Creates the Preamble 
+ * 
+ * @since 0.4
+ * 
+ * @param int TootPress Current Page
+ * @return string html
+ */
+
+ function tootpress_paint_preamble($tootpress_current_page) {
+
+	$preamble='';
+
+	if($tootpress_current_page==1) {
+
+		$preamble.=tootpress_preamble_filter_apply($preamble);
+
+		if($preamble) {
+			$preamble='<div class="tootpress-preamble">'.$preamble.'</div>';
+		}
+
+	}
+
+	return $preamble;
+
+}
+
 ?>

tootpress_hooks.php

@@ -11,16 +11,74 @@
 if (!defined('ABSPATH')) { exit; }
 
 /**
- * Fires hook when new toots are loaded
+ * Actions
+ */
+
+/**
+ * Fires when new toots are loaded
  * 
- * This hook can be used by other plugins.
- * For example: Refresh Cache
+ * This hook can be used by other plugins to process after load functions.
+ * For example: Cache Refresh
  * 
  * @since 0.1
  */
 
- function tootpress_fire_toots_update() {
+function tootpress_fire_toots_update() {
 	do_action( 'tootpress_toots_update' );
 }
 
+/**
+ * Action Example: tootpress_toots_update
+ * 
+ * @since 0.4
+ * 
+ * function tootpress_toots_update_postprocessing() {
+ *
+ * 		// Add your code to be executed here
+ *
+ * }
+ * add_action('tootpress_toots_update', 'tootpress_toots_update_postprocessing');
+ * 
+ */
+
+/**
+ * Filter
+ */
+
+/**
+ * Preample
+ * 
+ * This filter outputs html content before the toot loop. 
+ * 
+ * @since 0.4
+ * 
+ * @param string Unfiltered Preample
+ * @return html Filtered Preample
+ */
+
+function tootpress_preamble_filter_apply($preamble) {
+	$preamble.=apply_filters( 'tootpress_preamble_filter', $preamble );
+	return $preamble;
+}
+
+/**
+ * Filter Example: tootpress_preamble_filter
+ * 
+ * @since 0.4
+ * 
+ * @param string Unfiltered Preample
+ * @return html Filtered Preample
+ *
+ * function tootpress_preamble_add( $preamble ) {
+ * 
+ * 		// Add your filter code here
+ * 		// Example: $preamble='<p>Hello World.</p>';
+ * 
+ * 		return $preamble;
+ *
+ * }
+ * add_filter( 'tootpress_preamble_filter', 'tootpress_preamble_add', 10, 1 );
+ * 
+ */
+
 ?>

tootpress_loop.php

@@ -32,6 +32,9 @@ function tootpress_content($content) {
         // TootPress Content
         $tootpress_content='<div id="tootpress-area">';
 
+        // TootPress Preamble
+        $tootpress_content.=tootpress_paint_preamble($tootpress_current_page);
+
         // TootPress Loop
         $tootpress_content.=tootpress_loop($tootpress_current_page);