Plugin Directory

Changeset 3361728


Ignore:
Timestamp:
09/15/2025 11:44:36 AM (6 months ago)
Author:
jdahir0789
Message:

Adding first version of my plugin

Location:
text-wrapper
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • text-wrapper/trunk/readme.txt

    r3210842 r3361728  
    1 === Text Wrapper ===
     1=== Hook Locator ===
    22Contributors: jdahir0789
    3 Tags: custom button for tinymce, custom button for wysiwyg, wrap text, wysiwyg editor custom button, text wrapper
     3Tags: hooks, debug, search, actions, filters
    44Requires at least: 5.0
    5 Tested up to: 6.7
    6 Stable tag: 1.1
    7 Version: 1.1
    8 Author: JD Ahir
    9 Text Domain: text-wrapper
    10 Requires PHP: 7.2
     5Tested up to: 6.8
     6Stable tag: 1.0
     7Version: 1.0
     8Author: Jaydip Ahir
     9Text Domain: hook-locator
     10Requires PHP: 7.4
    1111License: GPLv2 or later
    12 License URI: http://www.gnu.org/licenses/gpl-2.0.html
    13 
    14 Easily wrap selected text in WordPress editors with custom HTML tags and CSS classes for better styling and structure.
    15 
    16 === Description ===
    17 
    18 Easily customize and style your content with the Text Wrapper plugin. Add a button to WordPress and ACF WYSIWYG editors to wrap selected text with your chosen HTML tag and CSS class. Perfect for applying consistent styles or custom behaviors without editing the HTML manually!
    19 
    20 - Easily highlight important sections of text in your posts or custom fields.
    21 - Add custom CSS styling to specific parts of your content.
    22 - Streamline workflows for developers, designers, and content editors working on styled content.
    23 
    24 === Features ===
    25 1. Custom HTML Wrapping: Wrap selected text with a configurable HTML tag and class directly in the WYSIWYG editor.
    26 2. Highlight Management: Automatically highlight wrapped text for better visibility.
    27 3. ACF Compatibility: Works seamlessly with ACF WYSIWYG fields, enhancing your custom fields experience.
    28 4. Keyboard Shortcut: Wrap text quickly using a customizable keyboard shortcut (Ctrl+Alt+W).
    29 5. Settings Page: Configure your preferred HTML tag and class easily in the WordPress settings page.
    30 6. Visual Feedback: Toggle wrapping dynamically with real-time button activation in TinyMCE.
     12License URI: https://www.gnu.org/licenses/gpl-2.0.html
     13
     14Professional WordPress hook analysis tool for developers. Search and analyze hook usage in plugins and themes with detailed code context.
     15
     16== Description ==
     17
     18**Hook Locator** is the ultimate WordPress development tool for analyzing hook usage across your plugins and themes. Built for developers, it provides a professional admin interface to search, analyze, and understand WordPress hook implementations.
     19
     20### Key Features
     21
     22* **Advanced Hook Search** - Find any WordPress hook across all plugins and themes
     23* **Organized Directory Selection** - Separate dropdowns for plugins and themes with clean organization 
     24* **Detailed Code Analysis** - View exact file locations with highlighted code context
     25* **Multiple Hook Types** - Supports add_action, add_filter, do_action, apply_filters, and more
     26* **Professional Interface** - Clean, modern admin UI following WordPress design standards
     27* **Performance Optimized** - Efficient scanning with built-in safeguards and limits
     28* **Security First** - Proper nonce verification, sanitization, and capability checks
     29* **Developer Tools** - Click-to-copy code snippets, keyboard shortcuts, and export features
     30
     31### Perfect For
     32
     33* **Plugin Developers** - Debug hook conflicts and understand plugin interactions
     34* **Theme Developers** - Analyze theme hook implementations and customizations 
     35* **Code Auditors** - Review hook usage patterns and security implementations
     36* **WordPress Learners** - Understand how WordPress hooks work in real code
     37* **Site Maintainers** - Debug issues and optimize hook performance
     38
     39### How It Works
     40
     411. **Search Interface** - Enter any hook name and select search location
     422. **Instant Results** - View all matching files with line numbers and hook types
     433. **Code Context** - Click any result to see highlighted code with surrounding lines
     444. **Analysis Tools** - Get insights about hook types, usage patterns, and best practices
     45
     46### WordPress Standards Compliant
     47
     48* **PHPCS/WPCS Compatible** - Follows all WordPress coding standards
     49* **Secure Implementation** - Proper sanitization, nonces, and capability checks
     50* **Performance Optimized** - Efficient file scanning with resource limits
     51* **Accessibility Ready** - Keyboard navigation and screen reader compatible
     52* **Translation Ready** - Full internationalization support
    3153
    3254== Installation ==
    3355
    34 1. Copy the `text-wrapper` folder into your `wp-content/plugins` folder.
    35 2. Activate the Text Wrapper plugin via the plugins admin page.
    36 3. Install and activate the plugin.
    37 4. Go to Settings → Text Wrapper to configure your preferred HTML tag and CSS class.
    38 5. In the editor, select the text you want to wrap.
    39 6. Click the Text Wrapper Button or use the shortcut Ctrl+Alt+W to apply the wrapper.
    40 7. The wrapped text is highlighted in the editor for easy identification.
     56### Automatic Installation
     571. Go to **Plugins > Add New** in your WordPress admin
     582. Search for "Hook Locator"
     593. Click **Install Now** and then **Activate**
     60
     61### Manual Installation
     621. Download the plugin ZIP file
     632. Go to **Plugins > Add New > Upload Plugin**
     643. Choose the ZIP file and click **Install Now**
     654. Activate the plugin
     66
     67### Getting Started
     681. Navigate to **Tools > Hook Locator** in your WordPress admin
     692. Enter a hook name (e.g., "init", "wp_head", "save_post")
     703. Select search location (All, specific plugin, or theme)
     714. Click **Search Hooks** to see results
     725. Click **View Details** on any result for code analysis
     73
     74== Frequently Asked Questions ==
     75
     76= Does this affect my site performance? =
     77
     78No! Hook Locator only runs in the WordPress admin when you actively search. There's no frontend code or background processing that affects your site's performance.
     79
     80= What file types does it search? =
     81
     82Hook Locator searches only PHP files (.php) since WordPress hooks are PHP-based. It automatically skips other file types for optimal performance.
     83
     84= Can I search for custom hooks? =
     85
     86Absolutely! Hook Locator finds any hook name you specify, including custom hooks created by plugins, themes, or your own code.
     87
     88= Is it safe to use on production sites? =
     89
     90Yes, Hook Locator is completely safe for production use. It only reads files and never modifies any code. All operations are restricted to users with administrator privileges.
     91
     92= Does it work with multisite? =
     93
     94Yes, Hook Locator works perfectly with WordPress multisite installations. Each site can use it independently to analyze their specific plugins and themes.
     95
     96= Can I export the search results? =
     97
     98Currently, you can copy individual code snippets to your clipboard. Future versions may include CSV/JSON export functionality based on user feedback.
     99
     100= What's the difference from other hook plugins? =
     101
     102Hook Locator focuses on static code analysis rather than runtime hook capture. This makes it more accurate, secure, and performant while providing deeper code insights.
     103
     104== Screenshots ==
     105
     1061. **Main Search Interface** - Clean, modern search form with organized directory selection
     1072. **Search Results** - Professional table showing files, line numbers, hook types, and actions 
     1083. **Code Analysis** - Detailed view with highlighted target line and surrounding context
     1094. **Hook Type Detection** - Color-coded badges showing different hook function types
     1105. **Mobile Responsive** - Works perfectly on all devices and screen sizes
    41111
    42112== Changelog ==
    43113
    44 = 1.1 =
    45 * Initial Release.
     114= 1.0.0 =
     115* Separated plugins and themes in dropdown with optgroups
     116* Much clearer code highlighting with better contrast
     117* Modern, professional UI with better spacing and typography
     118* Full WordPress coding standards compliance (PHPCS/WPCS)
     119* Comprehensive nonce verification and sanitization
     120* Proper Yoda conditions throughout codebase
     121* Complete function and class documentation
     122* All margin and padding issues for consistent layout
     123* Optimized file scanning with better resource management
     124* Complete rewrite for admin-only operation
     125* Added file scanning for plugin/theme directories
     126* New professional search interface with directory selection
     127* Detailed code context view with syntax highlighting
     128* Performance optimizations and security improvements
     129* Better user interface with WordPress admin styling
     130
     131== Advanced Usage ==
     132
     133### Keyboard Shortcuts
     134* **Ctrl/Cmd + K** - Focus search input
     135* **Ctrl/Cmd + Enter** - Submit search form 
     136* **Escape** - Clear search input
     137* **Click code snippets** - Copy to clipboard
     138
     139### Hook Types Supported
     140* `add_action()` - Register action hooks
     141* `add_filter()` - Register filter hooks 
     142* `do_action()` - Trigger action hooks
     143* `apply_filters()` - Apply filter hooks
     144* `remove_action()` - Remove action hooks
     145* `remove_filter()` - Remove filter hooks
     146* `has_action()` - Check for action hooks
     147* `has_filter()` - Check for filter hooks
     148
     149### Performance Features
     150* **Smart Scanning** - Skips large files and non-PHP files
     151* **Resource Limits** - Maximum 1000 files per search to prevent timeouts
     152* **Efficient Parsing** - Optimized regex patterns for hook detection
     153* **Memory Management** - Careful memory usage to prevent server issues
     154
     155== Developer Information ==
     156
     157### Code Standards
     158* **PHPCS/WPCS Compliant** - Passes all WordPress coding standards
     159* **Security First** - Proper sanitization, validation, and capability checks
     160* **Performance Optimized** - Efficient algorithms and resource management
     161* **Accessibility Ready** - Full keyboard navigation and screen reader support
     162* **Translation Ready** - Complete internationalization with proper text domains
     163
     164### Technical Specifications
     165* **Minimum PHP:** 7.4
     166* **WordPress:** 5.0+
     167* **File Size Limit:** 1MB per file
     168* **Scan Limit:** 1000 files per search
     169* **Memory Usage:** Optimized for shared hosting
     170
     171### Support & Development
     172* **GitHub:** Coming soon for issue reporting and contributions
     173* **Documentation:** Complete inline code documentation
     174* **Extensibility:** Action and filter hooks for customization
     175
     176== Screenshots ==
     1771. screenshot-1.png
     1782. screenshot-2.png
     1793. screenshot-3.png
     180
     181== Privacy ==
     182
     183Hook Locator respects your privacy and follows WordPress privacy best practices:
     184
     185* **No Data Collection** - No personal or usage data is collected or transmitted
     186* **Local Operation** - All scanning happens locally on your server
     187* **No External Requests** - No data is sent to external services
     188* **Admin Only** - Only users with administrator privileges can use the plugin
     189* **No Tracking** - No analytics, tracking pixels, or cookies are used
     190
     191== Support ==
     192
     193Need help with Hook Locator?
     194
     195* **Documentation** - Check the built-in help and tooltips in the admin interface
     196* **WordPress Forums** - Ask questions in the WordPress.org support forums
     197* **GitHub Issues** - Report bugs and request features (coming soon)
     198* **Professional Support** - Premium support available for enterprise users
     199
     200Hook Locator is actively maintained and supported. We're committed to keeping it updated with the latest WordPress versions and continuously improving its functionality based on user feedback.
Note: See TracChangeset for help on using the changeset viewer.