Changeset 3377895
- Timestamp:
- 10/14/2025 06:40:42 AM (6 months ago)
- File:
-
- 1 edited
-
text-wrapper/trunk/readme.txt (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
text-wrapper/trunk/readme.txt
r3361728 r3377895 1 === Hook Locator ===1 === Text Wrapper === 2 2 Contributors: jdahir0789 3 Tags: hooks, debug, search, actions, filters3 Tags: custom button for tinymce, custom button for wysiwyg, wrap text, wysiwyg editor custom button, text wrapper 4 4 Requires at least: 5.0 5 Tested up to: 6. 86 Stable tag: 1. 07 Version: 1. 08 Author: J aydipAhir9 Text Domain: hook-locator10 Requires PHP: 7. 45 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 11 11 License: GPLv2 or later 12 License URI: http s://www.gnu.org/licenses/gpl-2.0.html12 License URI: http://www.gnu.org/licenses/gpl-2.0.html 13 13 14 Professional WordPress hook analysis tool for developers. Search and analyze hook usage in plugins and themes with detailed code context.14 Easily wrap selected text in WordPress editors with custom HTML tags and CSS classes for better styling and structure. 15 15 16 == Description==16 === Description === 17 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. 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 19 20 ### Key Features 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. 21 23 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 41 1. **Search Interface** - Enter any hook name and select search location 42 2. **Instant Results** - View all matching files with line numbers and hook types 43 3. **Code Context** - Click any result to see highlighted code with surrounding lines 44 4. **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 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. 53 31 54 32 == Installation == 55 33 56 ### Automatic Installation 57 1. Go to **Plugins > Add New** in your WordPress admin 58 2. Search for "Hook Locator" 59 3. Click **Install Now** and then **Activate** 60 61 ### Manual Installation 62 1. Download the plugin ZIP file 63 2. Go to **Plugins > Add New > Upload Plugin** 64 3. Choose the ZIP file and click **Install Now** 65 4. Activate the plugin 66 67 ### Getting Started 68 1. Navigate to **Tools > Hook Locator** in your WordPress admin 69 2. Enter a hook name (e.g., "init", "wp_head", "save_post") 70 3. Select search location (All, specific plugin, or theme) 71 4. Click **Search Hooks** to see results 72 5. Click **View Details** on any result for code analysis 73 74 == Frequently Asked Questions == 75 76 = Does this affect my site performance? = 77 78 No! 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 82 Hook 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 86 Absolutely! 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 90 Yes, 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 94 Yes, 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 98 Currently, 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 102 Hook 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 106 1. **Main Search Interface** - Clean, modern search form with organized directory selection 107 2. **Search Results** - Professional table showing files, line numbers, hook types, and actions 108 3. **Code Analysis** - Detailed view with highlighted target line and surrounding context 109 4. **Hook Type Detection** - Color-coded badges showing different hook function types 110 5. **Mobile Responsive** - Works perfectly on all devices and screen sizes 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. 111 41 112 42 == Changelog == 113 43 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 == 177 1. screenshot-1.png 178 2. screenshot-2.png 179 3. screenshot-3.png 180 181 == Privacy == 182 183 Hook 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 193 Need 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 200 Hook 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. 44 = 1.1 = 45 * Initial Release.
Note: See TracChangeset
for help on using the changeset viewer.